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.

Build Steps from Json Plugin

step([$class: 'BuildStepsFromJsonBuilder']): Build Steps from Json

  • buildStep
      Nested Choice of Objects
    • $class: 'A3Builder'
      • project_file
        Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
        (Note: a³ workspace files (also .apx) are not supported as input.)
        • Type: String
      • analysis_ids
        The following values are allowed:
        • Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
        • No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
        • Type: String
      • pedantic_level
        • Type: String
      • export_a3apxworkspace
        Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
        • Type: String
      • copy_report_file
        • Type: boolean
      • copy_result_file
        • Type: boolean
      • skip_a3_analysis
        This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
        • Type: boolean
    • $class: 'ACSDeploymentBuilder'
      • context
          Nested Object
        • azureCredentialsId
          The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
          • Type: String
        • resourceGroupName
          Resource group of the target Azure Container Service.
          • Type: String
        • containerService
          The name of the Azure Container Service. Refer to the following documentation on how to setup Azure Container Service:
          • Type: String
        • sshCredentialsId

          The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).

          The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.

          • Type: String
        • configFilePaths

          The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.

          • Type: String
        • containerRegistryCredentials (optional)
          All the credentials needed for pulling images from private repositories. Specify multiple entries if your deployments need to pull images from multiple, private repositories that require authentication.
            Array / List of Nested Object
          • url
            URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
            • Type: String
          • credentialsId
            • Type: String
        • dcosDockerCredenditalsPathShared (optional)

          Determine if the Docker credentials archive upload path specified above is shared among all the agents.

          To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.

          Check this option if the Docker credentials archive upload path is a shared storage path.

          • Type: boolean
        • dcosDockerCredentialsPath (optional)

          The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.

          If not specified, the plugin will generate a path specific for the build with the following pattern.

          
          /home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>

          The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.

          
          "uris":  [
              "file://<filled-path>/docker.tar.gz"
          ]

          The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.

          Note that if an archive exists in the target path already, the build will overwrite that file.

          Reference: Marathon: Using a Private Docker Registry

          • Type: String
        • enableConfigSubstitution (optional)
          Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.

          This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.

          • Type: boolean
        • secretName (optional)
          The secret name that you can use in the Kubernetes Deployment configuration for the imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)

          If left blank, the plugin will generate a name based on the build name.

          The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.

          
          apiVersion: extensions/v1beta1
          kind: Deployment
          metadata:
            name: nginx
          spec:
            replicas: 1
            template:
              metadata:
                labels:
                  app: nginx
              spec:
                containers:
                - name: nginx
                  image: some.private.registry.domain/nginx
                  ports:
                  - containerPort: 80
                imagePullSecrets:
                - name: $KUBERNETES_SECRET_NAME
          

          Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.

          • Type: String
        • secretNamespace (optional)
          The Kubernetes namespace in which the secrets will be created with the credentials configured below.
          • Type: String
        • swarmRemoveContainersFirst (optional)
          Stop and remove containers first.
          • Type: boolean
    • qualysAPIStaticAssessment
      • freeUserType
        • Type: boolean
      • platform (optional)
        • Type: String
      • apiServer (optional)
        • Type: String
      • credsId (optional)
        • Type: String
      • useProxy (optional)
        • Type: boolean
      • proxyServer (optional)
        • Type: String
      • proxyPort (optional)
        • Type: int
      • proxyCredentialsId (optional)
        • Type: String
      • swaggerPath (optional)
        • Type: String
      • apiId (optional)
        • Type: String
      • isFailOnGrade (optional)
        • Type: boolean
      • grade (optional)
        • Type: String
      • isFailOnSecurityGroup (optional)
        • Type: boolean
      • securityGroupCount (optional)
        • Type: String
      • securityCriticality (optional)
        • Type: String
      • isFailOnDataGroup (optional)
        • Type: boolean
      • dataGroupCount (optional)
        • Type: String
      • dataCriticality (optional)
        • Type: String
      • isFailOnViolationGroup (optional)
        • Type: boolean
      • violationGroupCount (optional)
        • Type: String
      • violationCriticality (optional)
        • Type: String
      • token (optional)
        • Type: String
    • cfyAzureArm
      • azureCredentialsId (optional)

        The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.

        • Type: String
      • credentialsId (optional)

        The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

        • Type: String
      • debugOutput (optional)
        If checked, then printed Cloudify events and logs will include debug-level records.
        • Type: boolean
      • deploymentId (optional)
        • Type: String
      • echoEnvData (optional)

        If checked, then the created environment's data will be printed to the job's log.

        • Type: boolean
      • echoInputs (optional)
        If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
        • Type: boolean
      • envDataLocation (optional)

        Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.

        • Type: String
      • location (optional)

        The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.

        • Type: String
      • parameters (optional)

        YAML/JSON of parameters to pass to the template.

        • Type: java.util.Map<java.lang.String, java.lang.Object>
      • parametersAsString (optional)
        • Type: String
      • parametersFile (optional)

        Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.

        • Type: String
      • resourceGroupName (optional)

        Name of resource group to create for the template.

        • Type: String
      • templateFile (optional)

        Workspace-relative path of the ARM template file.

        • Type: String
      • tenant (optional)
        • Type: String
    • $class: 'AWSEBBuilder'
      • extensions
          Array / List of Nested Object
        • awsRegion
          AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
          • Values: GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1
        • awsRegionText
          AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
          • Type: String
        • credentialsString
          • Type: String
        • credentialsText
          Use a credentials name that will be resolved during the build.
          • Type: String
        • applicationName
          AWS EB Application Name (e.g.: "myapp")
          • Type: String
        • versionLabelFormat
          How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
          • Type: String
        • versionDescriptionFormat
          Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
          • Type: String
        • failOnError
          If any of the environments fail to update, or if there are no matching environments then fail the build.
          • Type: boolean
        • extensions
            Array / List of Nested Choice of Objects
          • $class: 'AWSEBElasticBeanstalkSetup'
          • $class: 'AWSEBS3Setup'
            • bucketName
              S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
              • Type: String
            • bucketRegion
              S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
              • Type: String
            • keyPrefix
              Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
              • Type: String
            • rootObject

              Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.

              It could be either a path to a zip file or a directory.

              If its a directory, includes and excludes are used to build the zip file

              • Type: String
            • includes
              Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
              • Type: String
            • excludes
              Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
              • Type: String
            • overwriteExistingFile
              • Type: boolean
            • useTransferAcceleration
              If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
              • Type: boolean
          • $class: 'ByName'
            • envNameList
              Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
              When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
              If not set, then all environments under the Application will be updated together.
              • Type: String
          • $class: 'ByUrl'
            • urlList
              Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
              When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
              If not set, then all environments under the Application will be updated together.
              • Type: String
        • envLookup
            Array / List of Nested Choice of Objects
          • $class: 'AWSEBElasticBeanstalkSetup'
          • $class: 'AWSEBS3Setup'
            • bucketName
              S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
              • Type: String
            • bucketRegion
              S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
              • Type: String
            • keyPrefix
              Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
              • Type: String
            • rootObject

              Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.

              It could be either a path to a zip file or a directory.

              If its a directory, includes and excludes are used to build the zip file

              • Type: String
            • includes
              Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
              • Type: String
            • excludes
              Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
              • Type: String
            • overwriteExistingFile
              • Type: boolean
            • useTransferAcceleration
              If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
              • Type: boolean
          • $class: 'ByName'
            • envNameList
              Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
              When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
              If not set, then all environments under the Application will be updated together.
              • Type: String
          • $class: 'ByUrl'
            • urlList
              Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
              When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
              If not set, then all environments under the Application will be updated together.
              • Type: String
    • $class: 'AWSEBDeploymentBuilder'
      • config
        • Type: class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
      • applicationName (optional)
        AWS EB Application Name (e.g.: "myapp")
        • Type: String
      • awsRegion (optional)
        AWS Region (e.g. us-east-1)
        • Type: String
      • bucketName (optional)

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

        (Optional, will call createStorageLocation if blank)

        • Type: String
      • checkHealth (optional)
        Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
        • Type: boolean
      • credentialId (optional)
        Select the credentials to use.
        • Type: String
      • environmentName (optional)

        Optional: AWS EB Environment name(s) to deploy to.

        Can accept single or multiple comma-separated values. Examples:

        • "my-prod-env" (single environment)
        • "my-dev-env,my-staging-env" (multiple environments)

        When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.

        • Type: String
      • excludes (optional)
        Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
        • Type: String
      • includes (optional)
        Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
        • Type: String
      • keyPrefix (optional)
        Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
        • Type: String
      • maxAttempts (optional)
        • Type: int
      • rootObject (optional)

        Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against

        Examples:

        • File, like target/mywebapp.war: The war file will be uploaded
        • A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
        • Type: String
      • skipEnvironmentUpdates (optional)
        • Type: boolean
      • sleepTime (optional)
        • Type: int
      • versionDescriptionFormat (optional)
        How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
        • Type: String
      • versionLabelFormat (optional)
        How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
        • Type: String
      • zeroDowntime (optional)
        • Type: boolean
    • awsebReleaser
      • credentialId
        Select the credentials to use.
        • Type: String
      • awsRegion
        AWS Region.
        • Type: String
      • applicationName
        AWS EB Application Name (e.g.: "myapp").
        • Type: String
      • environmentId
        AWS EB Environment name to deploy to.
        • Type: String
      • versionLabel
        • Type: String
    • abapCi
      • abapPackagename (optional)
        • Type: String
      • atcVariant (optional)
        • Type: String
      • runAtcChecks (optional)
        • Type: boolean
      • runUnitTests (optional)
        • Type: boolean
      • treatWarningAtcChecksAsErrors (optional)
        • Type: boolean
      • useJenkinsProjectName (optional)
        • Type: boolean
    • $class: 'ActionHubPlugin'
      • snActivatePlugin
        • credentialsId (optional)
          User name and password defined in global credentials (credentials ID is required here).
          This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
          • Type: String
        • apiVersion (optional)
          Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
          • Type: String
        • pluginId (optional)
          Unique identifier of the plugin. You can locate this identifier on the Plugins page within the card of the desired plugin; identified with the name "ID".
          • Type: String
        • url (optional)
          ServiceNow instance url. This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
          • Type: String
      • $class: 'AddComment'
        • prefix
          Enter the syntax. Example: P1#I10 (P3 - Project ID, I10 - Item ID). You can only add a comment up to 10 items.
          • Type: String
        • note
          Any malicious content will be automatically removed.
          • Type: String
        • logfile
          Upload the build log file as an attachment.
          • Type: String
      • $class: 'AddTestToSetStep'
        • domain
          HP ALM Domain
          • Type: String
        • project
          HP ALM Project name
          • Type: String
        • testPlanPath
          Path to a test or test folder in HP ALM which shall be added to a test set
          • Type: String
        • testSetPath
          Path to a test set in HP ALM into which test(s) shall be added
          • Type: String
      • $class: 'AmxEclipseAntBuilder'
        • targets
          Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
          • Type: String
        • name
          For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

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

          • Type: String
        • antOpts
          If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
          • Type: String
        • buildFile
          If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
          • Type: String
        • properties
          Properties needed by your ant build can be specified here (in standard properties file format):
          # comment
          name1=value1
          name2=$VAR2
          
          These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
          • Type: String
        • amxEclipseAntTra
          If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
          • Type: String
        • businessStudioWs
          If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
          • Type: String
      • anchore
        • name
          Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
          • Type: String
        • annotations (optional)
            Array / List of Nested Object
          • key
            • Type: String
          • value
            • Type: String
        • autoSubscribeTagUpdates (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
          • Type: boolean
        • bailOnFail (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
          • Type: boolean
        • bailOnPluginFail (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
          • Type: boolean
        • engineCredentialsId (optional)
          • Type: String
        • engineRetries (optional)
          Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
          • Type: String
        • engineurl (optional)
          Anchore Engine URL
          • Type: String
        • engineverify (optional)
          • Type: boolean
        • forceAnalyze (optional)
          If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
          • Type: boolean
        • policyBundleId (optional)
          ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
          • Type: String
      • $class: 'AnsibleAdHocCommandBuilder'
        • hostPattern
          The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
          • Type: String
        • inventory
            Nested Choice of Objects
          • $class: 'InventoryContent'
            • content
              • Type: String
            • dynamic
              Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
              • Type: boolean
          • $class: 'InventoryDoNotSpecify'
            • $class: 'InventoryPath'
              • path
                Specify the inventory host path or a comma separated host list
                • Type: String
          • module
            Module name to execute. The shell module is used when left empty.
            • Type: String
          • command
            Module arguments or shell command to execute
            • Type: String
          • additionalParameters (optional)
            Any additional parameters to pass to the ansible command.

            Warning:

            The content of this textbox will be passed as is to the command line.
            • Type: String
          • ansibleName (optional)
            • Type: String
          • becomeUser (optional)
            Desired become user. "root" is used when this field is empty.
            • Type: String
          • colorizedOutput (optional)
            Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
            • Type: boolean
          • credentialsId (optional)
            Select the credentials for the SSH connections. Only private key authentication is supported.
            • Type: String
          • disableHostKeyChecking (optional)
            Check this box if you really want to disable the validation of the hosts SSH server keys.
            • Type: boolean
          • extraVars (optional)
              Array / List of Nested Object
            • hidden (optional)
              • Type: boolean
            • key (optional)
              • Type: String
            • value (optional)
              • Type: String
          • forks (optional)
            Specify number of parallel processes to use. Set to 0 to use the default value.
            • Type: int
          • hostKeyChecking (optional)
            • Type: boolean
          • sudo (optional)
            Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
            • Type: boolean
          • sudoUser (optional)
            Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
            • Type: String
          • unbufferedOutput (optional)
            Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
            • Type: boolean
          • vaultCredentialsId (optional)
            Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
            • Type: String
        • cfyAnsible
          • additionalArgs (optional)
            • Type: String
          • ansibleEnvVars (optional)
            • Type: String
          • credentialsId (optional)

            The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

            • Type: String
          • debugLevel (optional)
            • Type: int
          • debugOutput (optional)
            • Type: boolean
          • deploymentId (optional)
            • Type: String
          • echoEnvData (optional)
            • Type: boolean
          • echoInputs (optional)
            If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
            • Type: boolean
          • envDataLocation (optional)
            • Type: String
          • optionsConfig (optional)
            • Type: String
          • playbookPath (optional)
            • Type: String
          • remergeSources (optional)
            • Type: boolean
          • runData (optional)
            • Type: String
          • savePlaybook (optional)
            • Type: boolean
          • scpExtraArgs (optional)
            • Type: String
          • sensitiveKeys (optional)
            • Type: String
          • sftpExtraArgs (optional)
            • Type: String
          • sourcePath (optional)
            • Type: String
          • sources (optional)
            • Type: String
          • sshCommonArgs (optional)
            • Type: String
          • sshExtraArgs (optional)
            • Type: String
          • startAtTask (optional)
            • Type: String
          • tenant (optional)
            • Type: String
          • timeout (optional)
            • Type: int
        • $class: 'AnsiblePlaybookBuilder'
          • playbook
            Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
            • Type: String
          • inventory
              Nested Choice of Objects
            • $class: 'InventoryContent'
              • content
                • Type: String
              • dynamic
                Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
                • Type: boolean
            • $class: 'InventoryDoNotSpecify'
              • $class: 'InventoryPath'
                • path
                  Specify the inventory host path or a comma separated host list
                  • Type: String
            • additionalParameters (optional)
              Any additional parameters to pass to the ansible command.

              Warning:

              The content of this textbox will be passed as is to the command line.
              • Type: String
            • ansibleName (optional)
              • Type: String
            • becomeUser (optional)
              Desired become user. "root" is used when this field is empty.
              • Type: String
            • colorizedOutput (optional)
              Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
              • Type: boolean
            • credentialsId (optional)
              Select the credentials for the SSH connections. Only private key authentication is supported.
              • Type: String
            • disableHostKeyChecking (optional)
              Check this box if you really want to disable the validation of the hosts SSH server keys.
              • Type: boolean
            • extraVars (optional)
                Array / List of Nested Object
              • hidden (optional)
                • Type: boolean
              • key (optional)
                • Type: String
              • value (optional)
                • Type: String
            • forks (optional)
              Specify number of parallel processes to use. Set to 0 to use the default value.
              • Type: int
            • hostKeyChecking (optional)
              • Type: boolean
            • limit (optional)
              Further limit selected hosts to an additional pattern.
              • Type: String
            • skippedTags (optional)
              only run plays and tasks whose tags do not match these values.
              • Type: String
            • startAtTask (optional)
              Start the playbook at the task matching this name.
              • Type: String
            • sudo (optional)
              Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
              • Type: boolean
            • sudoUser (optional)
              Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
              • Type: String
            • tags (optional)
              Only run plays and tasks tagged with these values.
              • Type: String
            • unbufferedOutput (optional)
              Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
              • Type: boolean
            • vaultCredentialsId (optional)
              Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
              • Type: String
          • $class: 'AnsibleTower'
            • towerServer (optional)
              • Type: String
            • jobTemplate (optional)
              • Type: String
            • towerCredentialsId (optional)
              • Type: String
            • jobType (optional)
              • Type: String
            • extraVars (optional)
              • Type: String
            • jobTags (optional)
              • Type: String
            • skipJobTags (optional)
              • Type: String
            • limit (optional)
              • Type: String
            • inventory (optional)
              • Type: String
            • credential (optional)
              • Type: String
            • scmBranch (optional)
              • Type: String
            • verbose (optional)
              • Type: boolean
            • importTowerLogs (optional)
              • Type: String
            • removeColor (optional)
              • Type: boolean
            • templateType (optional)
              • Type: String
            • importWorkflowChildLogs (optional)
              • Type: boolean
          • $class: 'AnsibleTowerProjectRevisionFreestyle'
            • towerServer (optional)
              • Type: String
            • towerCredentialsId (optional)
              • Type: String
            • project (optional)
              • Type: String
            • revision (optional)
              • Type: String
            • verbose (optional)
              • Type: boolean
            • throwExceptionWhenFail (optional)
              • Type: boolean
          • $class: 'AnsibleTowerProjectSyncFreestyle'
            • towerServer (optional)
              • Type: String
            • towerCredentialsId (optional)
              • Type: String
            • project (optional)
              • Type: String
            • verbose (optional)
              • Type: boolean
            • importTowerLogs (optional)
              • Type: boolean
            • removeColor (optional)
              • Type: boolean
          • $class: 'AnsibleVaultBuilder'
            • action (optional)
              Desired vault action.
              • Type: String
            • ansibleName (optional)
              • Type: String
            • content (optional)
              Desired encrypted content.
              • Type: String
            • input (optional)
              Desired input file to encrypt.
              • Type: String
            • newVaultCredentialsId (optional)
              Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
              • Type: String
            • output (optional)
              Desired output file for encrypted content.
              • Type: String
            • vaultCredentialsId (optional)
              Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
              • Type: String
          • ant
            For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

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

            • targets
              Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
              • Type: String
            • antName
              • Type: String
            • antOpts
              If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
              • Type: String
            • buildFile
              If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
              • Type: String
            • properties
              Properties needed by your ant build can be specified here (in standard properties file format):
              # comment
              name1=value1
              name2=$VAR2
              
              These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
              • Type: String
          • $class: 'AntExec'
            • scriptSource
              Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.

              The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
              • Type: String
            • extendedScriptSource
              Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
              • Type: String
            • scriptName
              Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
              • Type: String
            • properties
              Properties needed by your ant build can be specified here (in standard properties file format):
              # comment
              name1=value1
              name2=$VAR2
              
              These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
              • Type: String
            • antName
              • Type: String
            • antOpts
              If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
              Note that other Ant options (such as -lib) should not be here.
              • Type: String
            • keepBuildfile
              • Type: boolean
            • verbose
              • Type: boolean
            • emacs
              • Type: boolean
            • noAntcontrib

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

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

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

            • targets
              Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
              • Type: String
            • antName
              • Type: String
            • antOpts
              If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
              • Type: String
            • buildFile
              If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
              • Type: String
            • properties
              Properties needed by your ant build can be specified here (in standard properties file format):
              # comment
              name1=value1
              name2=$VAR2
              
              These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
              • Type: String
          • $class: 'ApiFortressBuilder'
            • mode
              When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
              • Type: String
            • hook
              The API Hook URL.
              API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
              You can create one in the API Fortress Company dashboard.
              • Type: String
            • id

              Test ID

              When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.

              Automatch URL

              When running in Automatch mode, introduce here the URL of the resource that you are willing to test.

              Tag

              When running in tag mode, introduce the tag of the tests you want to run.

              Project

              When running in project mode, no value is required.
              • Type: String
            • blocking
              Set this flag is a test failure must determine a build failure.
              • Type: boolean
            • dryrun
              Set this flag if you don't want the event to be stored in API Fortress.
              • Type: boolean
            • silent
              Set this flag if a failure should not generate API Fortress alerts.
              • Type: boolean
            • param1name
              • Type: String
            • param1value
              • Type: String
            • param2name
              • Type: String
            • param2value
              • Type: String
            • param3name
              • Type: String
            • param3value
              • Type: String
          • appray
            • appRayUrl
              App-Ray instance URL. Default: https://demo.app-ray.co
              • Type: String
            • outputFilePath
              Name of the binary file (apk, ipa) to be scanned relative to the workspace. You can use Jenkins variables to specify the filename.
              • Type: String
            • waitTimeout
              Timeout of waiting for ending of a scan. (For big application sometimes it take more than 30 minute!)
              • Type: int
            • riskScoreThreshold
              The minimum risk score to check the apk validity. It is the output of then scan. You can check the scores on the app-ray instance.
              • Type: int
            • credentialsId
              Use email address as a username and please provide a password. The user must have full-access access right in App-Ray in order to be able to submit applications for scanning.
              • Type: String
          • appscan
            • scanner
                Nested Choice of Objects
              • dynamic_analyzer
                • target
                  • Type: String
                • hasOptions
                  • Type: boolean
                • extraField (optional)
                  • Type: String
                • loginPassword (optional)
                  • Type: String
                • loginUser (optional)
                  • Type: String
                • optimization (optional)
                  • Type: String
                • presenceId (optional)
                  • Type: String
                • scanFile (optional)
                  • Type: String
                • scanType (optional)
                  • Type: String
                • testPolicy (optional)
                  • Type: String
              • mobile_analyzer
                • target
                  • Type: String
                • hasOptions
                  • Type: boolean
                • extraField (optional)
                  • Type: String
                • loginPassword (optional)
                  • Type: String
                • loginUser (optional)
                  • Type: String
                • presenceId (optional)
                  • Type: String
              • static_analyzer
                • target
                  • Type: String
                • hasOptions
                  • Type: boolean
                • openSourceOnly (optional)
                  • Type: boolean
            • name
              • Type: String
            • type
              • Type: String
            • application
              • Type: String
            • credentials
              • Type: String
            • email (optional)
              • Type: boolean
            • failBuild (optional)
              • Type: boolean
            • failBuildNonCompliance (optional)
              • Type: boolean
            • failureConditions (optional)
                Array / List of Nested Object
              • failureType
                • Type: String
              • threshold
                • Type: int
            • target (optional)
              • Type: String
            • wait (optional)
              • Type: boolean
          • appscanenterprise
            • credentials
              • Type: String
            • folder
              • Type: String
            • testPolicy
              • Type: String
            • template
              • Type: String
            • jobName
              • Type: String
            • accessId (optional)
              • Type: String
            • agent (optional)
              • Type: String
            • application (optional)
              • Type: String
            • email (optional)
              • Type: boolean
            • exploreData (optional)
              • Type: String
            • failBuild (optional)
              • Type: boolean
            • failureConditions (optional)
                Array / List of Nested Object
              • failureType
                • Type: String
              • threshold
                • Type: int
            • loginType (optional)
              • Type: String
            • scanType (optional)
              • Type: String
            • secretKey (optional)
              • Type: String
            • target (optional)
              • Type: String
            • testOptimization (optional)
              • Type: String
            • trafficFile (optional)
              • Type: String
            • wait (optional)
              • Type: boolean
          • $class: 'AppScanSourceBuilder'
            • disableScan
              • Type: boolean
            • applicationFile
              • Type: String
            • acceptSSL
              • Type: boolean
            • customScanWorkspace

              This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.

              If this field is blank, the default scan directory will be used.

              The default directory is this job's build folder, as defined by Jenkins.

              • Type: String
            • installation (optional)
              • Type: String
          • $class: 'AppScanStandardBuilder'
            • startingURL
              Insert the URL that you want AppScan Standard to start scanning from.

              Spiders will find the remaining URLs in the domain to be included for scanning.

              • Type: String
            • installation
              • Type: String
            • additionalCommands (optional)
              Provide additional and optional commands to run on AppScan Standard CLI.
              AppScanCMD exec|ex|e
              
                      Parameters:
                      [ /dest_scan|/dest|/d  ]
                      [ /base_scan|/base|/b  ]
                      [ /old_host|/ohost|/oh  ]
                      [ /new_host|/nhost|/nh  ]
                      [ /scan_template|/stemplate|/st  ]
                      [ /login_file|/lfile|/lf  ]
                      [ /multi_step_file|/mstepfile|/mf  ]
                      [ /manual_explore_file|/mexplorefile|/mef  ]
                      [ /policy_file|/pfile|/pf  ]
                      [ /additional_domains|/adomains|/ad  ]
                      [ /report_file|/rf  ]
                      [ /report_type|/rt  {xml} ]
                      [ /min_severity|/msev  {informational} ]
                      [ /test_type|/tt  ]
                      [ /report_template|/rtemplate|/rtm  {CliDefault} ]
              
                      Flags:
                      [ /verbose|/v {false} ]
                      [ /scan_log|/sl {false} ]
                      [ /explore_only|/eo {false} ]
                      [ /test_only|/to {false} ]
                      [ /multi_step|/mstep|/ms {false} ]
                      [ /continue|/c {false} ]
                      [ /merge_manual_explore_requests|/mmer {false} ]
                      [ /include_responses|/ir {false} ]
                      [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp  ]
              
                      Creates new scan with base_scan's configuration
                  saving dest_scan and creating report, if configured.
              
              AppScanCMD report|rep|r
              
                      Parametrs:
                      /base_scan|/base|/b
                      /report_file|/rf
                      /report_type|/rt
                      [ /min_severity|/msev  {informational} ]
                      [ /test_type|/tt  ]
                      [ /report_template|/rtemplate|/rtm  {CliDefault} ]
              
                      Flags:
                      [ /verbose|/v {false} ]
              
                      Creates a report for base_scan.
              
              AppScanCMD close_proxy|cprxy|cpr
              
                      Closes AppScan proxy if was previously opened.
              
              More info. at:
              (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
              http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
              
              
              • Type: String
            • authScan (optional)
              Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.

              If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.

              • Type: boolean
            • authScanPw (optional)
              Provide the password corresponding to the account's user name inserted above.

              Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.

              • Type: String
            • authScanRadio (optional)
              Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.

              A login sequence may be recorded using AppScan Standard's GUI by following these steps:

              "Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).

              Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.

              • Type: boolean
            • authScanUser (optional)
              Provide the user name of an account with access to the private functionalities of the website.

              Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.

              • Type: String
            • generateReport (optional)
              Check this option if you want AppScan Standard to generate a report after scannning.

              The report is available in HTML and PDF.

              The HTML report generated is ready to be integrated with the HTML Publisher Plugin.

              • Type: boolean
            • htmlReport (optional)
              This report can be integrated with the HTML Publisher Plugin.
              • Type: boolean
            • includeURLS (optional)
              This is used to include URLs for scanning,

              Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.

              • Type: String
            • pathRecordedLoginSequence (optional)
              Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
              • Type: String
            • pdfReport (optional)
              A PDF report is generated.
              • Type: boolean
            • policyFile (optional)
              Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.

              A Test Policy File can be created following these steps:

              "Scan" > "Scan Configuration" > "Test Policy" > "Export".

              • Type: String
            • reportName (optional)
              Provide the name to save the report with.

              To configure HTML Publisher Plugin properly, the names in the configuration must match.

              • Type: String
            • verbose (optional)
              Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
              • Type: boolean
          • xooa
            • name
              Xooa Jenkins
              • Type: String
            • appId
              • Type: String
          • $class: 'AppUploaderBuilder'
            • buildFilePath
              Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
              The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
              • Type: String
          • applatix
            • axUrl
              The URL of Applatix system. For example: https://applatix.yourcompany.com
              • Type: String
            • axUsername
              Applatix credential: username
              • Type: String
            • axPassword
              Applatix credential: password
              • Type: String
            • axServiceTemplateName
              • Type: String
            • axServiceTemplateRepository
              The repository where your Service Template is.
              • Type: String
            • axServiceTemplateBranch
              The branch where your Service Template is.
              • Type: String
            • axServiceTemplateParameters
              The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
                Array / List of Nested Object
              • key
                • Type: String
              • value
                • Type: String
          • snApplyChanges
            • credentialsId (optional)
              User name and password defined in global credentials (credentials ID is required here) used for the instance (usually where the application will be published).
              • Type: String
            • apiVersion (optional)
              Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
              • Type: String
            • appScope (optional)
              Required if 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.
              • Type: String
            • appSysId (optional)
              Required if 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.
              • Type: String
            • branchName (optional)
              Name of the branch in the source control system from which to acquire the application.
              • Type: String
            • url (optional)
              ServiceNow instance url (usually where the application will be published to).
              • Type: String
          • $class: 'ApprendaBuilder'
            • appAlias
              The Applicaton Alias to be used.
              • Type: String
            • appName
              The Applicaton Name to be used.
              • Type: String
            • versionAlias
              The application Version Alias to target.
              • Type: String
            • stage
              The desired Apprenda Application lifecycle Stage.
              • Type: String
            • artifactName
              The filename of the Apprenda Application Package. For example myapplication.zip.
              • Type: String
            • credentialsId
              • Type: String
            • prefix
              The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
              • Type: String
            • advVersionAliasToBeForced
              The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
              • Type: String
            • advancedNewVersionOption
              • Type: String
            • customPackageDirectory
              The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
              • Type: String
            • applicationPackageURL
              The complete URL to the Apprenda Application Package, starting with http:// or https://.
              • Type: String
            • archiveUploadMethod
              • Type: String
            • buildWithParameters
              Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
              • Type: boolean
          • aqua
            • locationType
              • Type: String
            • registry
              Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
              • Type: String
            • register
              • Type: boolean
            • localImage
              Path of local Docker image, including tag. E.g. my_ubuntu:latest
              • Type: String
            • hostedImage
              Path of Docker image on registry, including tag. E.g. google/mysql:latest
              • Type: String
            • onDisallowed
              • Type: String
            • notCompliesCmd
              A shell command to execute when image does not comply with Aqua security policy
              • Type: String
            • hideBase
              • Type: boolean
            • showNegligible
              • Type: boolean
            • policies
              Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
              • Type: String
            • customFlags
              • Type: String
            • tarFilePath (optional)
              • Type: String
          • aquaMicroscanner
            • imageName
              • Type: String
            • onDisallowed
              • Type: String
            • notCompliesCmd
              A shell command to execute when image does not comply with Aqua security policy
              • Type: String
            • outputFormat
              • Type: String
          • aquaServerlessScanner
            • onDisallowed
              • Type: String
            • notCompliesCmd
              • Type: String
            • codeScanPath
              • Type: String
            • customFlags
              • Type: String
          • arachniScanner
            • url
              URL of the system under scan.
              • Type: String
            • checks
              Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
              • Type: String
            • scope
                Nested Object
              • pageLimit
                Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
                • Type: int
              • excludePathPattern
                Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
                • Type: String
            • userConfig
                Nested Object
              • filename
                Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
                • Type: String
            • format
              • Type: String
          • $class: '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.

              • Type: String
            • basedir

              By default, the basedir is the job workspace.
              Give a value to override the default value.

              Path relative to workspace is permitted.

              • Type: String
            • excludes

              Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.

              • Type: String
            • remote

              Artifacts will be deployed in the specified output directory.
              The remote location must be accessible through the build machine (master/slave node).
              If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
              Make sure the Jenkins process have the right permissions to write to the remote location.
              For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.

              • Type: String
            • flatten

              Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.

              • Type: boolean
            • deleteRemote

              Delete the output directory before deploying artifacts.

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

              'Skip deletion' option preserves the files in the staging repository.

              Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.

              • Type: boolean
          • artifactResolver
            Resolves artifacts against one or more remote maven repositories.
            • artifacts
                Array / List of Nested Object
              • groupId
                • Type: String
              • artifactId
                • Type: String
              • version
                • Type: String
              • classifier (optional)
                • Type: String
              • deployToLocal (optional)
                • Type: boolean
              • deployToRemote (optional)
                • Type: boolean
              • extension (optional)
                • Type: String
              • failOnError (optional)
                • Type: boolean
              • pomFile (optional)
                • Type: String
              • targetFileName (optional)
                • Type: String
            • enableRepositoryLogging (optional)
              • Type: boolean
            • enableTransferLogging (optional)
              • Type: boolean
            • repositoryId (optional)
              • Type: String
            • targetDirectory (optional)
              • Type: String
          • assertthatBddFeatures
            • projectId
              Jira project id.
              • Type: String
            • credentialsId
              • Type: String
            • outputFolder

              Output folder for feature files withing workspace. Default ./features/.
              By default features are downloaded to the root of the workspace.
              • Type: String
            • jql
              • Type: String
            • tags
              • Type: String
            • mode
              • Type: String
            • proxyURI
              • Type: String
            • proxyUsername
              • Type: String
            • proxyPassword
              • Type: String
            • jiraServerUrl
              Jira Server URL. Populate only if using Jira Server version (e.g. https://mycompanyjira.com). Leave blank for cloud.
              • Type: String
          • $class: 'AssetBuilder'
            • name
              • Type: String
            • description
              • Type: String
            • version
              • Type: String
            • vendor
              • Type: String
            • platform
              • Type: String
            • architecture
              • Type: String
            • bits
              • Type: String
            • cpu
              • Type: int
            • memory
              • Type: int
            • storage
              • Type: int
            • installationScriptFilePath
              • Type: String
            • mediaFilePaths
                Array / List of Nested Object
              • path
                • Type: String
            • licenseFilePath
              • Type: String
            • documentationFilePath
              • Type: String
          • $class: 'AssociateItemToRelease'
            • releasePrefix
              Enter the release details. Example: P2#R10
              • Type: String
            • itemPrefix
              Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
              • Type: String
          • associateTag
            • nexusInstanceId
              • Type: String
            • tagName
              The tag which will be applied to components matching the specified search criteria
              • Type: String
            • search
              The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
                Array / List of Nested Object
              • key
                • Type: String
              • value
                • Type: String
          • $class: 'AstreeBuilder'
            • dax_file
              Absolute path to the DAX file containing the analysis specification and configuration.
              Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
              Paths and environment variables are evaluated on the machine running Jenkins.
              • Type: String
            • analysis_id
              ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
              Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
              • Type: String
            • output_dir
              Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
              Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
              • Type: String
            • skip_analysis
              This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
              • Type: boolean
            • genXMLOverview
              • Type: boolean
            • genXMLCoverage
              • Type: boolean
            • genXMLAlarmsByOccurence
              • Type: boolean
            • genXMLAlarmsByCategory
              • Type: boolean
            • genXMLAlarmsByFile
              • Type: boolean
            • genXMLRulechecks
              • Type: boolean
            • dropAnalysis
              When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
              This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
              Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
              This option corresponds to adding a --drop to a command line call to Astrée.
              • Type: boolean
            • genPreprocessOutput
              • Type: boolean
            • failonswitch
              This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
              • Only Errors
                ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
                This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
              • Errors and Alarms
                ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
                This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
              • Errors, Alarms, and Data-Flow Anomalies
                ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
                This setting fails builds on any reported potential code defect or anomaly.
                Nested Object
              • failon
                • Type: String
          • audit
            • credentialsId (optional)
              • Type: String
            • minScore (optional)
              • Type: int
            • collectionName (optional)
              • Type: String
            • platformUrl (optional)
              • Type: String
          • $class: 'AutEnvironmentBuilder'
            • autEnvironmentModel
                Nested Object
              • almServerName
                • Type: String
              • almUserName
                • Type: String
              • almPassword
                • Type: String
              • almDomain
                • Type: String
              • almProject
                • Type: String
              • clientType
                Client type should be provided if your server is ALM version 12.60 or above.
                • Type: String
              • autEnvironmentId
                Assign ID of an AUT Environment that exists in the ALM project you selected.
                • Type: String
              • useExistingAutEnvConf
                • Type: boolean
              • existingAutEnvConfId
                • Type: String
              • createNewAutEnvConf
                • Type: boolean
              • newAutEnvConfName
                • Type: String
              • autEnvironmentParameters
                  Array / List of Nested Object
                • name
                  The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)

                  For example: 'Parameters/DB_Setting/Oracle/username'
                  • Type: String
                • value
                  If you are using a 'From JSON' type, specify here the path for the element you would like to get.

                  Make sure you are using JsonPath style for defining it.
                  • Type: String
                • paramType
                  Manual - the value you'll assign for 'Parameter value' field will be used as is.

                  Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).

                  From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
                  • Type: String
                • shouldGetOnlyFirstValueFromJson
                  • Type: boolean
              • pathToJsonFile
                A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
                • Type: String
              • outputParameter
                The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.

                The parameter must be a String Parameter.

                If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
                • Type: String
          • $class: 'AutoConfigBuilder'
            • name
              • Type: String
            • discobitUrl
              • Type: String
            • discobitUser
              • Type: String
            • discobitPassword
              • Type: class hudson.util.Secret
            • configurations
              • Type: String
            • cuuid
              • Type: 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.

              • Type: String
            • environment

              Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.

              • Type: String
            • system

              Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.

              • Type: String
            • subsystem

              Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.

              • Type: String
            • stage

              Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.

              • Type: String
            • instance

              Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.

              • Type: String
            • signout

              Select this option to work with elements in CA Endevor® that might be currently worked on by another user.

              Select the Override signout option only if you have the permission to override the signout of another user.

              • Type: boolean
          • $class: 'AwsBatchBuilder'
            • jobname
              • Type: String
            • jobdefinition
              • Type: String
            • command
              • Type: String
            • jobqueue
              • Type: String
            • vcpu
              • Type: String
            • memory
              • Type: String
            • retries
              • Type: String
          • azureCLI
            • principalCredentialId
              The Service Principal credentials required to connect to your Azure account.
              More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
              If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
              If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
              • Type: String
            • commands
                Array / List of Nested Object
              • script
                • Type: String
              • exportVariablesString
                Export the output of the command to environment variables
                The format: /"variable from JSON" | "desired environment variable name"
                For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
                • Type: String
          • azureDownload
            • storageCredentialId
              • Type: String
            • downloadType
              • Type: String
            • buildSelector (optional)
                Nested Choice of Objects
              • downstream
                • upstreamProjectName

                  Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

                  Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

                  Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

                  AbstractProject based projects:
                  Freestyle projects
                  Multi-configuration projects
                  Maven projects
                  Non AbstractProject based projects:
                  Pipeline jobs (aka. Workflow jobs)

                  • Type: String
                • upstreamBuildNumber
                  The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
                  • Type: String
              • lastWithArtifacts
                • lastCompleted
                  • $class: 'MultiJobBuildSelector'
                    • buildParameter
                      • parameterName
                        Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

                        You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

                        • Type: String
                    • permalink
                      • id
                        • Type: String
                    • $class: 'PromotedBuildSelector'
                      • level
                        • Type: int
                    • latestSavedBuild
                      • specific
                        • buildNumber
                          While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
                          • Type: String
                      • lastSuccessful
                        • stable (optional)
                          • Type: boolean
                      • upstream
                        • allowUpstreamDependencies (optional)
                          • Type: boolean
                        • fallbackToLastSuccessful (optional)
                          • Type: boolean
                        • upstreamFilterStrategy (optional)
                          Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
                          • Values: UseGlobalSetting, UseOldest, UseNewest
                      • workspace
                      • containerName (optional)
                        Enter a storage container name.
                        Environment variables can also be referenced.
                        For example: ${JOB_NAME}
                        • Type: String
                      • deleteFromAzureAfterDownload (optional)
                        If checked, the file copy on Azure will be removed after it's downloaded to local.
                        • Type: boolean
                      • downloadDirLoc (optional)
                        Enter a download path. If not specified, the files will be downloaded into the job's workspace.
                        Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
                        • Type: String
                      • excludeFilesPattern (optional)
                        Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
                        For example: ${JOB_NAME}
                        • Type: String
                      • fileShare (optional)
                        Enter a Azure File Storage Share name.
                        Environment variables can also be referenced.
                        For example: ${JOB_NAME}
                        • Type: String
                      • flattenDirectories (optional)
                        If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
                        • Type: boolean
                      • includeArchiveZips (optional)
                        The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
                        • Type: boolean
                      • includeFilesPattern (optional)
                        Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
                        For example: ${JOB_NAME}
                        • Type: String
                      • projectName (optional)
                        The name of the project to download the managed artifact from.
                        • Type: String
                      • verbose (optional)

                        Enabling this will provide more logging on downloading files.

                        • Type: boolean
                    • $class: 'BDSBuilder'
                      • projectFile
                        • Type: String
                      • switches
                        • Type: String
                      • installationName
                        • Type: String
                    • $class: 'BapFtpBuilder'
                      Send files over FTP as a build step during the build.
                      • publishers
                          Array / List of Nested Object
                        • configName

                          Select an FTP configuration from the list configured in the global configuration of this Jenkins.

                          The configuration defines the connection properties and base directory of the FTP server.

                          • Type: String
                        • verbose
                          Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
                          • Type: boolean
                        • transfers
                            Array / List of Nested Object
                          • sourceFiles

                            Files to upload to a server.

                            The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
                            The base directory for this fileset is the workspace.

                            • Type: String
                          • excludes

                            Exclude files from the Transfer set.

                            The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)

                            • Type: String
                          • remoteDirectory

                            Optional destination folder.

                            This folder will be below the one in the global configuration, if present.
                            The folder will be created if does not exist.

                            • Type: String
                          • removePrefix

                            First part of the file path that should not be created on the remote server.

                            Directory structures are created relative to the base directory, which is usually the workspace.
                            You normally do not want the full path to these files to be created on the server.
                            For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
                            Jenkins environment variables can be used in this path.

                            If you use remove prefix, then ALL source file paths MUST start with the prefix.

                            • Type: String
                          • asciiMode

                            Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.

                            Use with ASCII text files to fix the line terminators when transferring between different operating systems.

                            • Type: boolean
                          • remoteDirectorySDF

                            Select this to include the timestamp in the remote directory.

                            The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
                            This setting turns the remote directory option into a java SimpleDateFormat.
                            The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
                            As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.

                            Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

                            Remote directory Directories created
                            'qa-approved/'yyyyMMddHHmmss qa-approved/20101107154555
                            'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' builds/2010/11/07/build-456 (if the build was number 456)
                            yyyy_MM/'build'-EEE-d-HHmmss 2010_11/build-Sun-7-154555
                            yyyy-MM-dd_HH-mm-ss 2010-11-07_15-45-55

                            • Type: boolean
                          • flatten

                            Only create files on the server, don't create directories (except for the remote directory, if present).

                            All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.

                            • Type: boolean
                          • cleanRemote

                            Select to delete all files and directories within the remote directory before transferring files.

                            • Type: boolean
                          • noDefaultExcludes
                            • Type: boolean
                          • makeEmptyDirs

                            The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
                            Selecting this option will create any directories that match the Source files pattern, even if empty.

                            • Type: boolean
                          • patternSeparator

                            The regular expression that is used to separate the Source files and Exclude files patterns.

                            The Source files and Exclude files both accept multiple patterns that by default are split using

                            [, ]+
                            which is how Ant, by default, handles multiple patterns in a single string.

                            The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

                            • Type: String
                        • useWorkspaceInPromotion

                          Set the root directory for the Source files to the workspace.

                          By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

                          If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

                          If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory

                          • Type: boolean
                        • usePromotionTimestamp

                          Use the build time of the promotion when the remote directory is a date format.

                          By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.

                          • Type: boolean
                        • ftpRetry

                          If publishing to this server fails, try again.

                          Files that were successfully transferred will not be re-sent.
                          If the Clean remote option is selected, and succeeds, it will not be attempted again.

                            Nested Object
                          • retries
                            The number of times to retry this server in the event of failure.
                            • Type: int
                          • retryDelay
                            The time to wait, in milliseconds, before attempting another transfer.
                            • Type: long
                        • ftpLabel

                          Set the label for this Server instance - for use with Parameterized publishing.

                          Expand the help for Parameterized publishing for more details.

                            Nested Object
                          • label

                            Set the label for this Server instance - for use with Parameterized publishing.

                            Expand the help for Parameterized publishing for more details.

                            • Type: String
                        • ftpCredentials
                          Set the username and password to use with this connection.

                          If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.

                            Nested Object
                          • username
                            • Type: String
                          • password
                            • Type: String
                      • continueOnError
                        • Type: boolean
                      • failOnError
                        • Type: boolean
                      • alwaysPublishFromMaster
                        • Type: boolean
                      • masterNodeName
                        • Type: String
                      • paramPublish
                          Nested Object
                        • parameterName
                          The name of the parameter or environment variable that will contain the expression for matching the labels.
                          • Type: String
                    • $class: 'BapSshBuilderPlugin'
                      Send files or execute commands over SSH as a build step during the build.
                      • publishers
                          Array / List of Nested Object
                        • configName

                          Select an SSH configuration from the list configured in the global configuration of this Jenkins.

                          The configuration defines the connection properties and base directory of the SSH server.

                          • Type: String
                        • verbose
                          Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems.
                          • Type: boolean
                        • transfers
                            Array / List of Nested Object
                          • sourceFiles

                            Files to upload to a server.

                            The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
                            The base directory for this fileset is the workspace.

                            • Type: String
                          • excludes

                            Exclude files from the Transfer set.

                            The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)

                            • Type: String
                          • remoteDirectory

                            Optional destination folder.

                            This folder will be below the one in the global configuration, if present.
                            The folder will be created if does not exist.

                            • Type: String
                          • removePrefix

                            First part of the file path that should not be created on the remote server.

                            Directory structures are created relative to the base directory, which is usually the workspace.
                            You normally do not want the full path to these files to be created on the server.
                            For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
                            Jenkins environment variables can be used in this path.

                            If you use remove prefix, then ALL source file paths MUST start with the prefix.

                            • Type: String
                          • remoteDirectorySDF

                            Select this to include the timestamp in the remote directory.

                            The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
                            This setting turns the remote directory option into a java SimpleDateFormat.
                            The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
                            As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.

                            Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

                            Remote directory Directories created
                            'qa-approved/'yyyyMMddHHmmss qa-approved/20101107154555
                            'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' builds/2010/11/07/build-456 (if the build was number 456)
                            yyyy_MM/'build'-EEE-d-HHmmss 2010_11/build-Sun-7-154555
                            yyyy-MM-dd_HH-mm-ss 2010-11-07_15-45-55

                            • Type: boolean
                          • flatten

                            Only create files on the server, don't create directories (except for the remote directory, if present).

                            All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.

                            • Type: boolean
                          • cleanRemote
                            • Type: boolean
                          • noDefaultExcludes
                            • Type: boolean
                          • makeEmptyDirs

                            The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
                            Selecting this option will create any directories that match the Source files pattern, even if empty.

                            • Type: boolean
                          • patternSeparator

                            The regular expression that is used to separate the Source files and Exclude files patterns.

                            The Source files and Exclude files both accept multiple patterns that by default are split using

                            [, ]+
                            which is how Ant, by default, handles multiple patterns in a single string.

                            The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

                            • Type: String
                          • execCommand (optional)

                            A command to execute on the remote server.

                            This command will be executed on the remote server after any files are transferred.
                            The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.

                            • Type: String
                          • execTimeout (optional)

                            Timeout in milliseconds for the Exec command.

                            Set to zero to disable.

                            • Type: int
                          • usePty (optional)

                            Exec the command in a pseudo tty.

                            This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
                            From the sudoers(5) man page:

                            requiretty      If set, sudo will only run when the user is logged in
                                            to a real tty.  When this flag is set, sudo can only be
                                            run from a login session and not via other means such
                                            as cron(8) or cgi-bin scripts.  This flag is off by
                                            default.
                                

                            • Type: boolean
                          • useAgentForwarding (optional)

                            Exec the command using Agent Forwarding.

                            Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.

                            From the ssh(1) man page:

                                    Enables forwarding of the authentication agent connection.  This can also be specified on a per-host basis in a configuration file.
                            
                                    Agent forwarding should be enabled with caution.  Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
                                    An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
                                
                            • Type: boolean
                          • useSftpForExec (optional)

                            Using SFTP protocol instead of SSH for Exec command.

                            Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls

                            • Type: boolean
                        • useWorkspaceInPromotion

                          Set the root directory for the Source files to the workspace.

                          By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

                          If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

                          If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.

                          • Type: boolean
                        • usePromotionTimestamp

                          Use the build time of the promotion when the remote directory is a date format.

                          By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.

                          • Type: boolean
                        • sshRetry

                          If publishing to this server or command execution fails, try again.

                          Files that were successfully transferred will not be re-sent.
                          If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.

                            Nested Object
                          • retries
                            The number of times to retry this server in the event of failure.
                            • Type: int
                          • retryDelay
                            The time to wait, in milliseconds, before attempting another transfer.
                            • Type: long
                        • sshLabel

                          Set the label for this Server instance - for use with Parameterized publishing.

                          Expand the help for Parameterized publishing for more details.

                            Nested Object
                          • label

                            Set the label for this Server instance - for use with Parameterized publishing.

                            Expand the help for Parameterized publishing for more details.

                            • Type: String
                        • sshCredentials
                          Set the credentials to use with this connection.

                          If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.

                            Nested Object
                          • username
                            The username to connect with.
                            • Type: String
                          • encryptedPassphrase
                            The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
                            Leave blank if the key is not encrypted.
                            • Type: String
                          • key

                            The private key.

                            Paste the private key here, or provide the path to the file containing the key in Path to key.

                            • Type: String
                          • keyPath

                            The path to the private key.

                            Either supply the path to the file containing the key, or paste the key into the Key box.
                            The Path to key can be absolute, or relative to $JENKINS_HOME

                            • Type: String
                      • continueOnError
                        • Type: boolean
                      • failOnError
                        • Type: boolean
                      • alwaysPublishFromMaster
                        • Type: boolean
                      • masterNodeName
                        • Type: String
                      • paramPublish
                          Nested Object
                        • parameterName
                          The name of the parameter or environment variable that will contain the expression for matching the labels.
                          • Type: String
                    • batchFile
                      • command
                        • Type: String
                      • configuredLocalRules (optional)
                          Array / List of Nested Choice of Objects
                        • retainOnlyVariables

                          Limit which environment variables are passed to a build step.

                          Environment variables passed to the build step are filtered, unless listed below.

                          The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:

                          • If the environment variable originates from Jenkins configuration, such as JOB_URL, it will not be passed to the build step unless specified here.
                          • If the environment variable originates from outside Jenkins, such as 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)
                            • Values: RESET, REMOVE
                          • retainCharacteristicEnvVars (optional)

                            When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.

                            • Type: boolean
                          • variables (optional)

                            Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.

                            • Type: String
                      • unstableReturn (optional)
                        If set, the batch errorlevel result that will be interpreted as an unstable build result. If the final errorlevel matches the value, the build results will be set to unstable and next steps will be continued. Supported values match the widest errorlevel range for Windows like systems. In Windows NT4 and beyond the ERRORLEVEL is stored as a four byte, signed integer, yielding maximum and minimum values of 2147483647 and -2147483648, respectively. Older versions of Windows use 2 bytes. DOS like systems use single byte, yielding errorlevels between 0-255. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.
                        • Type: int
                    • $class: 'BeaglePlugin'
                      • apptoken

                        Generate your Application Token From Beagle

                        Home -> Applications -> Select your Application -> Settings -> Application Token
                        • Type: class hudson.util.Secret
                      • accesstoken

                        Generate your Access Token From Beagle User Settings

                        Settings -> Access Token -> Generate Your New Personal Access Token
                        • Type: class hudson.util.Secret
                    • $class: 'BeakerBuilder'
                      • jobSource
                          Nested Choice of Objects
                        • $class: 'FileJobSource'
                          • jobPath
                            • Type: String
                        • $class: 'StringJobSource'
                          • jobContent
                            • Type: String
                      • downloadFiles
                        • Type: boolean
                    • $class: 'BeginAnalysis'
                      • logLevel
                        • Values: OFF, INFO, DEBUG, WARN, ERROR
                      • buildSessionId
                        • Type: String
                      • appName
                        • Type: String
                      • moduleName
                        • Type: String
                      • branch
                        • Type: String
                      • enableMultipleBuildFiles
                        • Type: boolean
                      • overrideJars
                        • Type: boolean
                      • multipleBuildFiles
                        • Type: boolean
                      • labId
                        • Type: String
                      • testStage
                        • Type: String
                      • packagesIncluded
                        • Type: String
                      • packagesExcluded
                        • Type: String
                      • filesIncluded
                        • Type: String
                      • filesExcluded
                        • Type: String
                      • classLoadersExcluded
                        In order to exclude class loaders from the build, please provide comma separated list of class loaders names to exclude. Class loader name should be the class loader full package name. e.g. 'com.example.package.SomeClassLoader'
                        • Type: String
                      • recursive
                        • Type: boolean
                      • workspacepath
                        • Type: String
                      • buildScannerJar
                        • Type: String
                      • testListenerJar
                        • Type: String
                      • testListenerConfigFile
                        • Type: String
                      • autoRestoreBuildFile
                        • Type: boolean
                      • sealightsMavenPluginInstallationArguments
                        • Type: String
                      • buildFilesPatterns
                        • Type: String
                      • buildFilesFolders
                        • Type: String
                      • logEnabled
                        • Type: boolean
                      • logDestination
                        • Values: CONSOLE, FILE
                      • logFolder
                        • Type: String
                      • buildStrategy
                        • Values: ONE_BUILD, BUILD_EACH_MODULE
                      • slMvnPluginVersion
                        • Type: String
                      • buildName
                          Nested Choice of Objects
                        • $class: 'DefaultBuildName'
                          • $class: 'EmptyBuildName'
                            • $class: 'LatestBuildName'
                              • $class: 'ManualBuildName'
                                • insertedBuildName
                                  • Type: String
                              • $class: 'UpstreamBuildName'
                                • upstreamProjectName
                                  • Type: String
                            • executionType
                              • Values: FULL, TESTS_ONLY, ONLY_LISTENER
                            • override_customerId
                              • Type: String
                            • override_url
                              • Type: String
                            • override_proxy
                              • Type: String
                            • additionalArguments
                              This section allows you to add additional arguments, as key-value pairs.
                              Example for additional arguments:

                              server=https://prod-sealights-gw.sealights.co
                              proxy=http://localhost:8888

                              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)
                              • Type: String
                            • includeResources
                              When checked, the build session id and token files will be added to the artifacts as as resources in the folder.
                              • Type: boolean
                          • benchmark
                            • filepath
                              Please insert a filepath.
                              • Type: String
                          • $class: 'BitbucketPublisher'
                            • serverUrl (optional)
                              Bitbucket Server Url.
                              • Type: String
                            • credentialsId (optional)
                              Credentials for bitucket server. The user must have access to create project and repository.
                              • Type: String
                            • projectKey (optional)
                              Input the project key for the bitbucket.
                              • Type: String
                            • createProject (optional)
                              Check this if you want to create the bitbucket project.
                                Nested Object
                              • projectName
                                • Type: String
                              • projectUsers
                                • Type: String
                              • projectGroups
                                • Type: String
                            • createJenkinsJobs (optional)
                              Check this if you want to use the bitbucket post commit external hook to call.
                                Nested Object
                              • ciServer
                                • Type: String
                            • projectName (optional)
                              Input name of the Bitbucket project.
                              • Type: String
                          • $class: 'BladeBuilder'
                            • blades
                                Array / List of Nested Choice of Objects
                              • $class: 'CodeScan'
                                • source
                                  • Type: String
                                • exclude
                                  • Type: String
                                • noCache
                                  • Type: boolean
                                • noProxy
                                  • Type: boolean
                                • noBlame
                                  • Type: boolean
                                • ruleset
                                  • Type: String
                                • severityLevel
                                  • Type: String
                                • severityThreshold
                                  • Type: int
                                • autoUpdate (optional)
                                  • Type: boolean
                                • credentialsId (optional)
                                  • Type: String
                                • debug (optional)
                                  • Type: boolean
                                • directory (optional)
                                  • Type: String
                                • environment (optional)
                                  • Type: String
                                • forceVersion (optional)
                                  • Type: String
                                • ignoreFailure (optional)
                                  • Type: boolean
                                • onFailureCmd (optional)
                                  • Type: String
                                • timeout (optional)
                                  • Type: int
                              • $class: 'ImageScan'
                                • image
                                  • Type: String
                                • exclude
                                  • Type: String
                                • noCache
                                  • Type: boolean
                                • noProxy
                                  • Type: boolean
                                • noBlame
                                  • Type: boolean
                                • ruleset
                                  • Type: String
                                • severityLevel
                                  • Type: String
                                • severityThreshold
                                  • Type: int
                                • autoUpdate (optional)
                                  • Type: boolean
                                • credentialsId (optional)
                                  • Type: String
                                • debug (optional)
                                  • Type: boolean
                                • directory (optional)
                                  • Type: String
                                • environment (optional)
                                  • Type: String
                                • forceVersion (optional)
                                  • Type: String
                                • ignoreFailure (optional)
                                  • Type: boolean
                                • onFailureCmd (optional)
                                  • Type: String
                                • timeout (optional)
                                  • Type: int
                          • $class: 'BlueprintLaunch'
                            • projectName

                              Project selection is mandatory.

                              • Type: String
                            • blueprintName

                              Blueprint selection is mandatory.

                              • Type: String
                            • applicationName

                              Application Name is mandatory.

                              This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.

                              • Type: String
                            • appProfileName

                              Application Profile selection is mandatory.

                              • Type: String
                            • actionName

                              The field is mandatory


                              Select the required action need to run after the application launch from the list of actions, else please select none.

                              • Type: String
                            • runtimeVariables

                              Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.

                              • Type: String
                            • waitForSuccessFulLaunch
                              • Type: boolean
                            • blueprintDescription

                              Description is fetched from the selected Calm blueprint

                              • Type: String
                          • $class: 'BootPluginBuilder'
                            • tasks
                              Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
                              • Type: String
                            • jvmOpts
                              Specify JVM Options to be used within boot tasks.
                              • Type: String
                          • $class: 'BranchDestructionStep'
                            • project
                              • Type: String
                            • branch
                              • Type: String
                          • $class: 'BranchGenerationStep'
                            • projectConfig
                                Nested Object
                              • pipelineConfig
                                  Nested Object
                                • destructor
                                  • Type: boolean
                                • authorisations
                                  • Type: String
                                • branchSCMParameter
                                  • Type: boolean
                                • branchParameters
                                  • Type: String
                                • generationExtension
                                  • Type: String
                                • pipelineGenerationExtension
                                  • Type: String
                                • disableDslScript
                                  • Type: boolean
                                • scriptDirectory
                                  • Type: String
                                • namingStrategy
                                    Nested Object
                                  • projectFolderPath
                                    • Type: String
                                  • branchFolderPath
                                    • Type: String
                                  • projectSeedName
                                    • Type: String
                                  • projectDestructorName
                                    • Type: String
                                  • branchSeedName
                                    • Type: String
                                  • branchStartName
                                    • Type: String
                                  • branchName
                                    • Type: String
                                  • ignoredBranchPrefixes
                                    • Type: String
                                • eventStrategy
                                    Nested Object
                                  • delete
                                    • Type: boolean
                                  • auto
                                    • Type: boolean
                                  • trigger
                                    • Type: boolean
                                  • commit
                                    • Type: String
                              • project
                                • Type: String
                              • scmType
                                • Type: String
                              • scmUrl
                                • Type: String
                              • scmCredentials
                                • Type: String
                              • triggerIdentifier
                                • Type: String
                              • triggerType
                                • Type: String
                              • triggerSecret
                                • Type: String
                          • dotnetBuild
                            The dotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
                            1. An executable that can be used to run the application, if the project type is an executable targeting .NET Core 3.0 or later.
                            2. Symbol files used for debugging, with a .pdb extension.
                            3. A .deps.json file, which lists the dependencies of the application or library.
                            4. A .runtimeconfig.json file, which specifies the shared runtime and its version for an application.
                            5. Other libraries that the project depends on (via project references or NuGet package references).
                            • configuration (optional)
                              Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
                              • Type: String
                            • force (optional)
                              Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
                              • Type: boolean
                            • framework (optional)
                              Compiled for a specific framework. The framework must be defined in the project file.
                              • Type: String
                            • noDependencies (optional)
                              Ignores project-to-project references and only restores the root project.
                              • Type: boolean
                            • noIncremental (optional)
                              Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
                              • Type: boolean
                            • noRestore (optional)
                              Doesn't execute an implicit restore when running the command.
                              • Type: boolean
                            • nologo (optional)
                              Doesn't display the startup banner or the copyright message.

                              Available since: .NET Core SDK 3.0
                              • Type: boolean
                            • option (optional)
                              • Type: String
                            • options (optional)
                              • Type: Array / List of String
                            • optionsString (optional)
                              For more information about these options, see the MSBuild Command-Line Reference.
                              If targets and/or properties are also configured, those will be passed after these options.
                              • Type: String
                            • outputDirectory (optional)
                              Directory in which to place the built binaries. If not specified, the default path is ./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.
                              • Type: String
                            • project (optional)
                              The MSBuild project or solution to build. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
                              • Type: String
                            • properties (optional)
                              • Type: java.util.Map<java.lang.String, java.lang.String>
                            • propertiesString (optional)
                              Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
                              • Type: String
                            • runtime (optional)
                              Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog.
                              • Type: String
                            • sdk (optional)
                              Name of a .NET SDK to use so that dotnet will be in the path.
                              If the default is specified, you either need to use the With .NET element (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.
                              • Type: String
                            • showSdkInfo (optional)
                              If enabled, 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.
                              • Type: boolean
                            • shutDownBuildServers (optional)
                              If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
                              Note: If this is not specified, a build that causes such a build server to be started may hang until 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).

                              Available since: .NET Core SDK 2.1
                              • Type: boolean
                            • specificSdkVersion (optional)
                              Depending on the platform, the 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.
                              By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
                              Note: This will silently overwrite any global.json already present in the current directory.
                              • Type: boolean
                            • target (optional)
                              • Type: String
                            • targets (optional)
                              • Type: Array / List of String
                            • targetsString (optional)
                              Specifies the MSBuild targets to build. If none are specified, the default target specified in the project will be built.
                              • Type: String
                            • unstableIfWarnings (optional)
                              If this is set and the build completes successfully with warnings, the build will be marked as unstable.
                              • Type: boolean
                            • verbosity (optional)
                              Sets the MSBuild verbosity level.
                              • Type: String
                            • versionSuffix (optional)
                              Sets the value of the $(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.
                              • Type: String
                            • workDirectory (optional)
                              The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
                              • Type: String
                          • buildAddUrl
                            • title
                              • Type: String
                            • url
                              • Type: String
                          • $class: 'BuildBuilder'
                            • dbFolder
                                Nested Object
                              • value
                                • Values: vcsroot, subfolder, scaproject
                              • subfolder
                                • Type: String
                              • projectPath
                                • Type: String
                            • packageid
                              Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
                              • Type: String
                            • tempServer
                                Nested Object
                              • value
                                • Type: String
                              • serverName
                                • Type: String
                              • dbName
                                • Type: String
                              • serverAuth
                                  Nested Object
                                • value
                                  • Type: String
                                • username
                                  • Type: String
                                • password
                                  • Type: class hudson.util.Secret
                              • encryptConnection
                                • Type: boolean
                              • trustServerCertificate
                                • Type: boolean
                            • options
                              • Type: String
                            • dataOptions
                              • Type: String
                            • transactionIsolationLevel
                              • Values: Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommitted
                            • filter
                              • Type: String
                            • packageVersion
                              Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
                              • Type: String
                            • dlmDashboard
                                Nested Object
                              • dlmDashboardHost
                                • Type: String
                              • dlmDashboardPort
                                • Type: String
                            • sqlChangeAutomationVersionOption
                                Nested Object
                              • value
                                • Values: Latest, Specific
                              • specificVersion
                                • Type: String
                          • buildDescription
                            Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.
                            • descriptionTemplate
                              • Type: String
                          • buildName
                            Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.
                            • nameTemplate
                              • Type: String
                          • $class: 'BuildNameUpdater'
                            This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.
                            • fromFile
                              • Type: boolean
                            • buildName
                              • Type: String
                            • fromMacro
                              • Type: boolean
                            • macroTemplate
                              • Type: String
                            • macroFirst
                              • Type: boolean
                          • crxBuild
                            Create and build a content package on CRX by specifying a workspace filter, and then download it to the workspace to get archived as a backup, or as the beginning of a magical content package adventure, full of drama, suspense, and deployments to lower environments!
                            • packageId (optional)
                              Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

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

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

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

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

                              http://deployer@localhost:4502

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

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

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

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

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

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

                              For example, to include everything under /etc except for packages:

                                      /etc                 # define /etc as the filter root
                                      +/etc(/.*)?          # include everything under /etc
                                      -/etc/packages(/.)?  # exclude package paths
                                  
                              To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:

                                      /content/acme        # include the site content
                                      /apps/acme           # include the app code
                                  
                              This field supports parameter tokens.
                              • Type: String
                          • $class: 'BuildScanner'
                            Trigger automated Acunetix scans as part of your web application's build process
                            • profile
                              The Scan Type used to scan the target
                              • Type: String
                            • target
                              The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
                              • Type: String
                            • repTemp
                              Generate a Report after the scan completes. The report is available for download from Acunetix backend within a time frame of one hour
                              • Type: String
                            • threat
                              The Threat Level (High, Medium, Low) to fail the build on
                              • Type: String
                            • stopScan
                              If selected, the scan will be stopped if the build fails (Threat Level is reached)
                              • Type: boolean
                            • svRep
                              Option to download the report in the project workspace from where it can be used for other operations like attaching to an email or archiving.
                              Note: Archiving can be done with "Archive the artifacts" post-build action
                              • Type: boolean
                            • incScan
                              This will create an Incremental scan. The first scan will scan all the site. Subsequent scans will only scan the changes in the site, resulting in smaller scans.
                              • Type: boolean
                            • incScanId
                              • Type: String
                            • stopTargetScans
                              This is useful when older versions of the web application are discarded by the CI/CD when an updated version is created.
                              • Type: boolean
                          • $class: 'BuildStepBuilder'
                            • sourceFolderMode
                              • Type: String
                            • subfolder
                              • Type: String
                            • packageId
                              • Type: String
                            • serverType
                              • Type: String
                            • server
                              • Type: String
                            • authenticationType
                              • Type: String
                            • userName
                              • Type: String
                            • password
                              • Type: class hudson.util.Secret
                            • database
                              • Type: String
                            • compareOptions (optional)
                              • Type: String
                            • filterFile (optional)
                              • Type: String
                            • transactionIsoLvl (optional)
                              • Type: String
                          • $class: 'BuildStepWithTimeout'
                            • buildStep
                              • Type: Build Step (hudson.tasks.BuildStep)
                            • strategy
                                Nested Choice of Objects
                              • $class: 'AbsoluteTimeOutStrategy'

                                Abort build based on a fixed time-out.

                                • timeoutMinutes
                                  If configured, and if a build does not complete by the specified amount of time (in minutes; at least 3), then the build will be terminated automatically and marked as aborted. This is useful if you have experienced infinite loops in your test, for example.
                                  • Type: String
                              • $class: 'DeadlineTimeOutStrategy'

                                Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).

                                • deadlineTime
                                  If configured, and if a build does not complete by next deadline time (specified in 24-hour format as HH:MM:SS or HH:MM), then the build will be terminated automatically and marked as indicated in the time-out actions ("aborted" by default).
                                  Variable references are allowed to define deadline time.
                                  • Type: String
                                • deadlineToleranceInMinutes
                                  Period in minutes after the deadline time when a job should be immediately aborted. E.g. if deadline is defined as "13:50", tolerance as "5" minutes and job is scheduled to run at "13:52" it will be immediately aborted. However if it is scheduled at "13:56", job's deadline will be set at "13:50" of next day.
                                  • Type: 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
                                  If the build duration lasts longer than this percentage of the three most recent non-failing builds, the build will be terminated and marked as aborted. If there are no successful builds, the "Timeout minutes if no successful or unstable builds" field will be used instead.
                                  • Type: String
                                • timeoutMinutesElasticDefault
                                  • Type: String
                                • numberOfBuilds
                                  • Type: String
                                • failSafeTimeoutDuration
                                  • Type: boolean
                              • $class: 'LikelyStuckTimeOutStrategy'

                                Abort the build when the job has taken many times longer than previous runs.

                                • $class: 'NoActivityTimeOutStrategy'
                                  Timeout when specified seconds has passed since the last log output.
                                  • timeoutSecondsString
                                    Seconds to detect timeout since the last log output. This is useful to abort a build if no activity for long time. Be careful with log output delay for buffering.
                                    • Type: String
                                • $class: 'RunConditionTimeoutStrategy'
                                  Sets a conditional timeout. The strategy will take a timeout from a first matching condition. The default value will be used if all evaluations fail or return false.

                                  This extension uses run condition as condition sources.

                                  • conditions
                                      Array / List of Nested Object
                                    • condition
                                      A Run Condition to be evaluated.
                                        Nested Choice of Objects
                                      • $class: 'AlwaysRun'
                                        • $class: 'And'
                                          • conditions
                                              Array / List of Nested Object
                                            • condition
                                                Nested Choice of Objects
                                              • $class: 'AlwaysRun'
                                                • $class: 'And'
                                                • $class: 'BatchFileCondition'
                                                  • command
                                                    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                    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.

                                                    • Type: String
                                                • $class: 'BooleanCondition'
                                                  • token
                                                    • Type: String
                                                • $class: 'CauseCondition'
                                                  Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                  • buildCause
                                                    The cause why the build was triggered. The following causes are supported:
                                                    • UserCause - the build was triggered by a manual interaction
                                                    • SCMTrigger - the build was triggered by a SCM change
                                                    • TimerTrigger - the build was triggered by a timer
                                                    • CLICause - the build was triggered by via CLI interface
                                                    • RemoteCause - the build was triggered via remote interface
                                                    • UpstreamCause - the build was triggered by an upstream project
                                                    The following causes are supported if the XTrigger plugin is installed:
                                                    • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                    • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                    • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                    • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                    • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                    • Type: String
                                                  • exclusiveCause
                                                    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                    • Type: boolean
                                                • $class: 'DayCondition'
                                                  • useBuildTime
                                                    Use the build time instead of the the time that the condition is evaluated.

                                                    For long running builds, there can be a considerable difference between these two times.

                                                    • Type: boolean
                                                  • daySelector
                                                    For which days do you want the build to run?

                                                    Weekends
                                                    Saturday and Sunday
                                                    Weekdays
                                                    Not a weekend
                                                    Select days
                                                    Choose the days for which the build should run

                                                      Nested Choice of Objects
                                                    • $class: 'SelectDays'
                                                      • days
                                                          Array / List of Nested Object
                                                        • day
                                                          • Type: int
                                                        • selected
                                                          • Type: boolean
                                                    • $class: 'Weekday'
                                                      • $class: 'Weekend'
                                                    • $class: 'ExpressionCondition'
                                                      • expression
                                                        The regular expression used to match the label - Java regular expression syntax
                                                        • Type: String
                                                      • label
                                                        The label that will be tested by the regular expression
                                                        • Type: String
                                                    • $class: 'ExtendedCauseCondition'
                                                      • condition
                                                          Nested Choice of Objects
                                                        • $class: 'UpstreamCauseCondition'
                                                          • projects
                                                            Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                            • Type: String
                                                        • $class: 'UserBuildCauseCondition'
                                                          • users
                                                            Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                            • Type: String
                                                      • exclusiveCause
                                                        There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                        • Type: boolean
                                                    • $class: 'FileExistsCondition'
                                                      • file
                                                        • Type: String
                                                      • baseDir
                                                          Nested Choice of Objects
                                                        • $class: 'ArtifactsDir'
                                                          • $class: 'JenkinsHome'
                                                            • $class: 'Workspace'
                                                          • $class: 'FilesMatchCondition'
                                                            • includes
                                                              • Type: String
                                                            • excludes
                                                              • Type: String
                                                            • baseDir
                                                                Nested Choice of Objects
                                                              • $class: 'ArtifactsDir'
                                                                • $class: 'JenkinsHome'
                                                                  • $class: 'Workspace'
                                                                • $class: 'LegacyBuildstepCondition'
                                                                  • condition
                                                                    • Type: String
                                                                  • invert
                                                                    • Type: boolean
                                                                • $class: 'NeverRun'
                                                                  • $class: 'NodeCondition'
                                                                    • allowedNodes
                                                                      • Type: Array / List of String
                                                                  • $class: 'Not'
                                                                    • condition
                                                                        Nested Choice of Objects
                                                                      • $class: 'AlwaysRun'
                                                                        • $class: 'And'
                                                                        • $class: 'BatchFileCondition'
                                                                          • command
                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                            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.

                                                                            • Type: String
                                                                        • $class: 'BooleanCondition'
                                                                          • token
                                                                            • Type: String
                                                                        • $class: 'CauseCondition'
                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                          • buildCause
                                                                            The cause why the build was triggered. The following causes are supported:
                                                                            • UserCause - the build was triggered by a manual interaction
                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                            • TimerTrigger - the build was triggered by a timer
                                                                            • CLICause - the build was triggered by via CLI interface
                                                                            • RemoteCause - the build was triggered via remote interface
                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                            • Type: String
                                                                          • exclusiveCause
                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                            • Type: boolean
                                                                        • $class: 'DayCondition'
                                                                          • useBuildTime
                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                            • Type: boolean
                                                                          • daySelector
                                                                            For which days do you want the build to run?

                                                                            Weekends
                                                                            Saturday and Sunday
                                                                            Weekdays
                                                                            Not a weekend
                                                                            Select days
                                                                            Choose the days for which the build should run

                                                                              Nested Choice of Objects
                                                                            • $class: 'SelectDays'
                                                                              • days
                                                                                  Array / List of Nested Object
                                                                                • day
                                                                                  • Type: int
                                                                                • selected
                                                                                  • Type: boolean
                                                                            • $class: 'Weekday'
                                                                              • $class: 'Weekend'
                                                                            • $class: 'ExpressionCondition'
                                                                              • expression
                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                • Type: String
                                                                              • label
                                                                                The label that will be tested by the regular expression
                                                                                • Type: String
                                                                            • $class: 'ExtendedCauseCondition'
                                                                              • condition
                                                                                  Nested Choice of Objects
                                                                                • $class: 'UpstreamCauseCondition'
                                                                                  • projects
                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                    • Type: String
                                                                                • $class: 'UserBuildCauseCondition'
                                                                                  • users
                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                    • Type: String
                                                                              • exclusiveCause
                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                • Type: boolean
                                                                            • $class: 'FileExistsCondition'
                                                                              • file
                                                                                • Type: String
                                                                              • baseDir
                                                                                  Nested Choice of Objects
                                                                                • $class: 'ArtifactsDir'
                                                                                  • $class: 'JenkinsHome'
                                                                                    • $class: 'Workspace'
                                                                                  • $class: 'FilesMatchCondition'
                                                                                    • includes
                                                                                      • Type: String
                                                                                    • excludes
                                                                                      • Type: String
                                                                                    • baseDir
                                                                                        Nested Choice of Objects
                                                                                      • $class: 'ArtifactsDir'
                                                                                        • $class: 'JenkinsHome'
                                                                                          • $class: 'Workspace'
                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                          • condition
                                                                                            • Type: String
                                                                                          • invert
                                                                                            • Type: boolean
                                                                                        • $class: 'NeverRun'
                                                                                          • $class: 'NodeCondition'
                                                                                            • allowedNodes
                                                                                              • Type: Array / List of String
                                                                                          • $class: 'Not'
                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                            • lhs
                                                                                              • Type: String
                                                                                            • rhs
                                                                                              • Type: String
                                                                                            • comparator
                                                                                                Nested Choice of Objects
                                                                                              • $class: 'EqualTo'
                                                                                                • $class: 'GreaterThan'
                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                    • $class: 'LessThan'
                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                        • $class: 'NotEqualTo'
                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                        • ontrackScriptLocation
                                                                                                            Nested Object
                                                                                                          • value
                                                                                                            • Type: String
                                                                                                          • scriptPath
                                                                                                            • Type: String
                                                                                                          • scriptText
                                                                                                            • Type: String
                                                                                                        • sandbox
                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                          • Type: boolean
                                                                                                        • injectEnvironment
                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                              
                                                                                                          • Type: String
                                                                                                        • injectProperties

                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                          For example, the following text:

                                                                                                                  BRANCH = 1.0
                                                                                                                  BUILD = ${VERSION}
                                                                                                              

                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                              

                                                                                                          In the text:

                                                                                                          • declare properties using name = value syntax
                                                                                                          • empty lines are ignored
                                                                                                          • lines started by # are ignored
                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                          • Type: String
                                                                                                        • ontrackLog
                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                          • Type: boolean
                                                                                                      • $class: 'Or'
                                                                                                        • conditions
                                                                                                            Array / List of Nested Object
                                                                                                      • $class: 'ShellCondition'
                                                                                                        • command
                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                          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

                                                                                                          • Type: String
                                                                                                      • $class: 'StatusCondition'
                                                                                                        • worstResult
                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                          • Type: String
                                                                                                        • bestResult
                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                          • Type: String
                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                        • arg1
                                                                                                          • Type: String
                                                                                                        • arg2
                                                                                                          • Type: String
                                                                                                        • ignoreCase
                                                                                                          Ignore the case of the strings when matching them
                                                                                                          • Type: boolean
                                                                                                      • $class: 'TextFinderCondition'
                                                                                                        • fileSet
                                                                                                          • Type: String
                                                                                                        • regexp
                                                                                                          • Type: String
                                                                                                        • checkConsoleOutput
                                                                                                          • Type: boolean
                                                                                                      • $class: 'TimeCondition'
                                                                                                        • earliest
                                                                                                          • Type: String
                                                                                                        • latest
                                                                                                          • Type: String
                                                                                                        • useBuildTime
                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                          • Type: boolean
                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                        • variableName
                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                          • Type: String
                                                                                                  • $class: 'NumericalComparisonCondition'
                                                                                                    • lhs
                                                                                                      • Type: String
                                                                                                    • rhs
                                                                                                      • Type: String
                                                                                                    • comparator
                                                                                                        Nested Choice of Objects
                                                                                                      • $class: 'EqualTo'
                                                                                                        • $class: 'GreaterThan'
                                                                                                          • $class: 'GreaterThanOrEqualTo'
                                                                                                            • $class: 'LessThan'
                                                                                                              • $class: 'LessThanOrEqualTo'
                                                                                                                • $class: 'NotEqualTo'
                                                                                                              • $class: 'OntrackDSLRunCondition'
                                                                                                                • ontrackScriptLocation
                                                                                                                    Nested Object
                                                                                                                  • value
                                                                                                                    • Type: String
                                                                                                                  • scriptPath
                                                                                                                    • Type: String
                                                                                                                  • scriptText
                                                                                                                    • Type: String
                                                                                                                • sandbox
                                                                                                                  If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                  • Type: boolean
                                                                                                                • injectEnvironment
                                                                                                                  Comma-separated list of environment variable (like 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}", '')
                                                                                                                      
                                                                                                                  • Type: String
                                                                                                                • injectProperties

                                                                                                                  You can define variables to inject into the script by using a property-like format.

                                                                                                                  For example, the following text:

                                                                                                                          BRANCH = 1.0
                                                                                                                          BUILD = ${VERSION}
                                                                                                                      

                                                                                                                  would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                          ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                      

                                                                                                                  In the text:

                                                                                                                  • declare properties using name = value syntax
                                                                                                                  • empty lines are ignored
                                                                                                                  • lines started by # are ignored
                                                                                                                  • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                  • Type: String
                                                                                                                • ontrackLog
                                                                                                                  If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                  • Type: boolean
                                                                                                              • $class: 'Or'
                                                                                                                • conditions
                                                                                                                    Array / List of Nested Object
                                                                                                              • $class: 'ShellCondition'
                                                                                                                • command
                                                                                                                  Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                  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

                                                                                                                  • Type: String
                                                                                                              • $class: 'StatusCondition'
                                                                                                                • worstResult
                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                  • Type: String
                                                                                                                • bestResult
                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                  • Type: String
                                                                                                              • $class: 'StringsMatchCondition'
                                                                                                                • arg1
                                                                                                                  • Type: String
                                                                                                                • arg2
                                                                                                                  • Type: String
                                                                                                                • ignoreCase
                                                                                                                  Ignore the case of the strings when matching them
                                                                                                                  • Type: boolean
                                                                                                              • $class: 'TextFinderCondition'
                                                                                                                • fileSet
                                                                                                                  • Type: String
                                                                                                                • regexp
                                                                                                                  • Type: String
                                                                                                                • checkConsoleOutput
                                                                                                                  • Type: boolean
                                                                                                              • $class: 'TimeCondition'
                                                                                                                • earliest
                                                                                                                  • Type: String
                                                                                                                • latest
                                                                                                                  • Type: String
                                                                                                                • useBuildTime
                                                                                                                  Use the build time instead of the the time that the condition is evaluated.

                                                                                                                  For long running builds, there can be a considerable difference between these two times.

                                                                                                                  • Type: boolean
                                                                                                              • $class: 'VariableExistsCondition'
                                                                                                                • variableName
                                                                                                                  Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                  • Type: String
                                                                                                        • $class: 'BatchFileCondition'
                                                                                                          • command
                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                            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.

                                                                                                            • Type: String
                                                                                                        • $class: 'BooleanCondition'
                                                                                                          • token
                                                                                                            • Type: String
                                                                                                        • $class: 'CauseCondition'
                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                          • buildCause
                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                            • Type: String
                                                                                                          • exclusiveCause
                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                            • Type: boolean
                                                                                                        • $class: 'DayCondition'
                                                                                                          • useBuildTime
                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                            • Type: boolean
                                                                                                          • daySelector
                                                                                                            For which days do you want the build to run?

                                                                                                            Weekends
                                                                                                            Saturday and Sunday
                                                                                                            Weekdays
                                                                                                            Not a weekend
                                                                                                            Select days
                                                                                                            Choose the days for which the build should run

                                                                                                              Nested Choice of Objects
                                                                                                            • $class: 'SelectDays'
                                                                                                              • days
                                                                                                                  Array / List of Nested Object
                                                                                                                • day
                                                                                                                  • Type: int
                                                                                                                • selected
                                                                                                                  • Type: boolean
                                                                                                            • $class: 'Weekday'
                                                                                                              • $class: 'Weekend'
                                                                                                            • $class: 'ExpressionCondition'
                                                                                                              • expression
                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                • Type: String
                                                                                                              • label
                                                                                                                The label that will be tested by the regular expression
                                                                                                                • Type: String
                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                              • condition
                                                                                                                  Nested Choice of Objects
                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                  • projects
                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                    • Type: String
                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                  • users
                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                    • Type: String
                                                                                                              • exclusiveCause
                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                • Type: boolean
                                                                                                            • $class: 'FileExistsCondition'
                                                                                                              • file
                                                                                                                • Type: String
                                                                                                              • baseDir
                                                                                                                  Nested Choice of Objects
                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                    • $class: 'Workspace'
                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                    • includes
                                                                                                                      • Type: String
                                                                                                                    • excludes
                                                                                                                      • Type: String
                                                                                                                    • baseDir
                                                                                                                        Nested Choice of Objects
                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                          • $class: 'Workspace'
                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                          • condition
                                                                                                                            • Type: String
                                                                                                                          • invert
                                                                                                                            • Type: boolean
                                                                                                                        • $class: 'NeverRun'
                                                                                                                          • $class: 'NodeCondition'
                                                                                                                            • allowedNodes
                                                                                                                              • Type: Array / List of String
                                                                                                                          • $class: 'Not'
                                                                                                                            • condition
                                                                                                                                Nested Choice of Objects
                                                                                                                              • $class: 'AlwaysRun'
                                                                                                                                • $class: 'And'
                                                                                                                                  • conditions
                                                                                                                                      Array / List of Nested Object
                                                                                                                                    • condition
                                                                                                                                        Nested Choice of Objects
                                                                                                                                      • $class: 'AlwaysRun'
                                                                                                                                        • $class: 'And'
                                                                                                                                        • $class: 'BatchFileCondition'
                                                                                                                                          • command
                                                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                            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.

                                                                                                                                            • Type: String
                                                                                                                                        • $class: 'BooleanCondition'
                                                                                                                                          • token
                                                                                                                                            • Type: String
                                                                                                                                        • $class: 'CauseCondition'
                                                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                          • buildCause
                                                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                            • Type: String
                                                                                                                                          • exclusiveCause
                                                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                            • Type: boolean
                                                                                                                                        • $class: 'DayCondition'
                                                                                                                                          • useBuildTime
                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                            • Type: boolean
                                                                                                                                          • daySelector
                                                                                                                                            For which days do you want the build to run?

                                                                                                                                            Weekends
                                                                                                                                            Saturday and Sunday
                                                                                                                                            Weekdays
                                                                                                                                            Not a weekend
                                                                                                                                            Select days
                                                                                                                                            Choose the days for which the build should run

                                                                                                                                              Nested Choice of Objects
                                                                                                                                            • $class: 'SelectDays'
                                                                                                                                              • days
                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                • day
                                                                                                                                                  • Type: int
                                                                                                                                                • selected
                                                                                                                                                  • Type: boolean
                                                                                                                                            • $class: 'Weekday'
                                                                                                                                              • $class: 'Weekend'
                                                                                                                                            • $class: 'ExpressionCondition'
                                                                                                                                              • expression
                                                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                • Type: String
                                                                                                                                              • label
                                                                                                                                                The label that will be tested by the regular expression
                                                                                                                                                • Type: String
                                                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                                                              • condition
                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                                                  • projects
                                                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                    • Type: String
                                                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                                                  • users
                                                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                    • Type: String
                                                                                                                                              • exclusiveCause
                                                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                • Type: boolean
                                                                                                                                            • $class: 'FileExistsCondition'
                                                                                                                                              • file
                                                                                                                                                • Type: String
                                                                                                                                              • baseDir
                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                                                    • includes
                                                                                                                                                      • Type: String
                                                                                                                                                    • excludes
                                                                                                                                                      • Type: String
                                                                                                                                                    • baseDir
                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                                                          • condition
                                                                                                                                                            • Type: String
                                                                                                                                                          • invert
                                                                                                                                                            • Type: boolean
                                                                                                                                                        • $class: 'NeverRun'
                                                                                                                                                          • $class: 'NodeCondition'
                                                                                                                                                            • allowedNodes
                                                                                                                                                              • Type: Array / List of String
                                                                                                                                                          • $class: 'Not'
                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                            • lhs
                                                                                                                                                              • Type: String
                                                                                                                                                            • rhs
                                                                                                                                                              • Type: String
                                                                                                                                                            • comparator
                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                            Nested Object
                                                                                                                                                                          • value
                                                                                                                                                                            • Type: String
                                                                                                                                                                          • scriptPath
                                                                                                                                                                            • Type: String
                                                                                                                                                                          • scriptText
                                                                                                                                                                            • Type: String
                                                                                                                                                                        • sandbox
                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                          • Type: boolean
                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                              
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • injectProperties

                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                              

                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                              

                                                                                                                                                                          In the text:

                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • ontrackLog
                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                          • Type: boolean
                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                        • conditions
                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                        • command
                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                          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

                                                                                                                                                                          • Type: String
                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                        • worstResult
                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • bestResult
                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                          • Type: String
                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                        • arg1
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • arg2
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • ignoreCase
                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                          • Type: boolean
                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                        • fileSet
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • regexp
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                          • Type: boolean
                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                        • earliest
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • latest
                                                                                                                                                                          • Type: String
                                                                                                                                                                        • useBuildTime
                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                          • Type: boolean
                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                        • variableName
                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                          • Type: String
                                                                                                                                                                • $class: 'BatchFileCondition'
                                                                                                                                                                  • command
                                                                                                                                                                    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                    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.

                                                                                                                                                                    • Type: String
                                                                                                                                                                • $class: 'BooleanCondition'
                                                                                                                                                                  • token
                                                                                                                                                                    • Type: String
                                                                                                                                                                • $class: 'CauseCondition'
                                                                                                                                                                  Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                  • buildCause
                                                                                                                                                                    The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                    • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                    • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                    • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                    • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                    • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                    • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                    The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                    • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                    • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                    • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                    • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                    • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                    • Type: String
                                                                                                                                                                  • exclusiveCause
                                                                                                                                                                    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                    • Type: boolean
                                                                                                                                                                • $class: 'DayCondition'
                                                                                                                                                                  • useBuildTime
                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                    • Type: boolean
                                                                                                                                                                  • daySelector
                                                                                                                                                                    For which days do you want the build to run?

                                                                                                                                                                    Weekends
                                                                                                                                                                    Saturday and Sunday
                                                                                                                                                                    Weekdays
                                                                                                                                                                    Not a weekend
                                                                                                                                                                    Select days
                                                                                                                                                                    Choose the days for which the build should run

                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                    • $class: 'SelectDays'
                                                                                                                                                                      • days
                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                        • day
                                                                                                                                                                          • Type: int
                                                                                                                                                                        • selected
                                                                                                                                                                          • Type: boolean
                                                                                                                                                                    • $class: 'Weekday'
                                                                                                                                                                      • $class: 'Weekend'
                                                                                                                                                                    • $class: 'ExpressionCondition'
                                                                                                                                                                      • expression
                                                                                                                                                                        The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                        • Type: String
                                                                                                                                                                      • label
                                                                                                                                                                        The label that will be tested by the regular expression
                                                                                                                                                                        • Type: String
                                                                                                                                                                    • $class: 'ExtendedCauseCondition'
                                                                                                                                                                      • condition
                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                        • $class: 'UpstreamCauseCondition'
                                                                                                                                                                          • projects
                                                                                                                                                                            Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                            • Type: String
                                                                                                                                                                        • $class: 'UserBuildCauseCondition'
                                                                                                                                                                          • users
                                                                                                                                                                            Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                            • Type: String
                                                                                                                                                                      • exclusiveCause
                                                                                                                                                                        There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                        • Type: boolean
                                                                                                                                                                    • $class: 'FileExistsCondition'
                                                                                                                                                                      • file
                                                                                                                                                                        • Type: String
                                                                                                                                                                      • baseDir
                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                          • $class: 'FilesMatchCondition'
                                                                                                                                                                            • includes
                                                                                                                                                                              • Type: String
                                                                                                                                                                            • excludes
                                                                                                                                                                              • Type: String
                                                                                                                                                                            • baseDir
                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                              • $class: 'ArtifactsDir'
                                                                                                                                                                                • $class: 'JenkinsHome'
                                                                                                                                                                                  • $class: 'Workspace'
                                                                                                                                                                                • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                  • condition
                                                                                                                                                                                    • Type: String
                                                                                                                                                                                  • invert
                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                • $class: 'NeverRun'
                                                                                                                                                                                  • $class: 'NodeCondition'
                                                                                                                                                                                    • allowedNodes
                                                                                                                                                                                      • Type: Array / List of String
                                                                                                                                                                                  • $class: 'Not'
                                                                                                                                                                                  • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                    • lhs
                                                                                                                                                                                      • Type: String
                                                                                                                                                                                    • rhs
                                                                                                                                                                                      • Type: String
                                                                                                                                                                                    • comparator
                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                      • $class: 'EqualTo'
                                                                                                                                                                                        • $class: 'GreaterThan'
                                                                                                                                                                                          • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                            • $class: 'LessThan'
                                                                                                                                                                                              • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                • $class: 'NotEqualTo'
                                                                                                                                                                                              • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                • ontrackScriptLocation
                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                  • value
                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                  • scriptPath
                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                  • scriptText
                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                • sandbox
                                                                                                                                                                                                  If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                • injectEnvironment
                                                                                                                                                                                                  Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                      
                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                • injectProperties

                                                                                                                                                                                                  You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                  For example, the following text:

                                                                                                                                                                                                          BRANCH = 1.0
                                                                                                                                                                                                          BUILD = ${VERSION}
                                                                                                                                                                                                      

                                                                                                                                                                                                  would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                          ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                      

                                                                                                                                                                                                  In the text:

                                                                                                                                                                                                  • declare properties using name = value syntax
                                                                                                                                                                                                  • empty lines are ignored
                                                                                                                                                                                                  • lines started by # are ignored
                                                                                                                                                                                                  • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                • ontrackLog
                                                                                                                                                                                                  If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                              • $class: 'Or'
                                                                                                                                                                                                • conditions
                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                  • condition
                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                    • $class: 'AlwaysRun'
                                                                                                                                                                                                      • $class: 'And'
                                                                                                                                                                                                        • conditions
                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                      • $class: 'BatchFileCondition'
                                                                                                                                                                                                        • command
                                                                                                                                                                                                          The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                          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.

                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                      • $class: 'BooleanCondition'
                                                                                                                                                                                                        • token
                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                      • $class: 'CauseCondition'
                                                                                                                                                                                                        Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                        • buildCause
                                                                                                                                                                                                          The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                          • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                          • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                          • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                          • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                          • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                          • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                          The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                          • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                          • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                          • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                          • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                          • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                      • $class: 'DayCondition'
                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                        • daySelector
                                                                                                                                                                                                          For which days do you want the build to run?

                                                                                                                                                                                                          Weekends
                                                                                                                                                                                                          Saturday and Sunday
                                                                                                                                                                                                          Weekdays
                                                                                                                                                                                                          Not a weekend
                                                                                                                                                                                                          Select days
                                                                                                                                                                                                          Choose the days for which the build should run

                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                          • $class: 'SelectDays'
                                                                                                                                                                                                            • days
                                                                                                                                                                                                                Array / List of Nested Object
                                                                                                                                                                                                              • day
                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                              • selected
                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                          • $class: 'Weekday'
                                                                                                                                                                                                            • $class: 'Weekend'
                                                                                                                                                                                                          • $class: 'ExpressionCondition'
                                                                                                                                                                                                            • expression
                                                                                                                                                                                                              The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                            • label
                                                                                                                                                                                                              The label that will be tested by the regular expression
                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                          • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                              • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                • projects
                                                                                                                                                                                                                  Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                              • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                • users
                                                                                                                                                                                                                  Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                          • $class: 'FileExistsCondition'
                                                                                                                                                                                                            • file
                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                            • baseDir
                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                              • $class: 'ArtifactsDir'
                                                                                                                                                                                                                • $class: 'JenkinsHome'
                                                                                                                                                                                                                  • $class: 'Workspace'
                                                                                                                                                                                                                • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                  • includes
                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                  • excludes
                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                  • baseDir
                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                    • $class: 'ArtifactsDir'
                                                                                                                                                                                                                      • $class: 'JenkinsHome'
                                                                                                                                                                                                                        • $class: 'Workspace'
                                                                                                                                                                                                                      • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                        • invert
                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                      • $class: 'NeverRun'
                                                                                                                                                                                                                        • $class: 'NodeCondition'
                                                                                                                                                                                                                          • allowedNodes
                                                                                                                                                                                                                            • Type: Array / List of String
                                                                                                                                                                                                                        • $class: 'Not'
                                                                                                                                                                                                                        • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                          • lhs
                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                          • rhs
                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                          • comparator
                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                            • $class: 'EqualTo'
                                                                                                                                                                                                                              • $class: 'GreaterThan'
                                                                                                                                                                                                                                • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                  • $class: 'LessThan'
                                                                                                                                                                                                                                    • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                      • $class: 'NotEqualTo'
                                                                                                                                                                                                                                    • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                      • ontrackScriptLocation
                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                        • value
                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                        • scriptPath
                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                        • scriptText
                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                      • sandbox
                                                                                                                                                                                                                                        If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                      • injectEnvironment
                                                                                                                                                                                                                                        Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • injectProperties

                                                                                                                                                                                                                                        You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                        For example, the following text:

                                                                                                                                                                                                                                                BRANCH = 1.0
                                                                                                                                                                                                                                                BUILD = ${VERSION}
                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                        would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                        In the text:

                                                                                                                                                                                                                                        • declare properties using name = value syntax
                                                                                                                                                                                                                                        • empty lines are ignored
                                                                                                                                                                                                                                        • lines started by # are ignored
                                                                                                                                                                                                                                        • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • ontrackLog
                                                                                                                                                                                                                                        If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                    • $class: 'Or'
                                                                                                                                                                                                                                    • $class: 'ShellCondition'
                                                                                                                                                                                                                                      • command
                                                                                                                                                                                                                                        Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                    • $class: 'StatusCondition'
                                                                                                                                                                                                                                      • worstResult
                                                                                                                                                                                                                                        The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • bestResult
                                                                                                                                                                                                                                        The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                    • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                      • arg1
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • arg2
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • ignoreCase
                                                                                                                                                                                                                                        Ignore the case of the strings when matching them
                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                    • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                      • fileSet
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • regexp
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • checkConsoleOutput
                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                    • $class: 'TimeCondition'
                                                                                                                                                                                                                                      • earliest
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • latest
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                      • useBuildTime
                                                                                                                                                                                                                                        Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                        For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                    • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                      • variableName
                                                                                                                                                                                                                                        Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                              • $class: 'ShellCondition'
                                                                                                                                                                                                                                • command
                                                                                                                                                                                                                                  Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                              • $class: 'StatusCondition'
                                                                                                                                                                                                                                • worstResult
                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • bestResult
                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                              • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                • arg1
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • arg2
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • ignoreCase
                                                                                                                                                                                                                                  Ignore the case of the strings when matching them
                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                              • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                • fileSet
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • regexp
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • checkConsoleOutput
                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                              • $class: 'TimeCondition'
                                                                                                                                                                                                                                • earliest
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • latest
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                • useBuildTime
                                                                                                                                                                                                                                  Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                  For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                              • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                • variableName
                                                                                                                                                                                                                                  Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                            • lhs
                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                            • rhs
                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                            • comparator
                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                          • scriptPath
                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                          • scriptText
                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                        • sandbox
                                                                                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                        • injectProperties

                                                                                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                          In the text:

                                                                                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                        • ontrackLog
                                                                                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                                                                                        • conditions
                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                          • condition
                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                            • $class: 'AlwaysRun'
                                                                                                                                                                                                                                              • $class: 'And'
                                                                                                                                                                                                                                                • conditions
                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                              • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                • command
                                                                                                                                                                                                                                                  The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                              • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                • token
                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                              • $class: 'CauseCondition'
                                                                                                                                                                                                                                                Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                • buildCause
                                                                                                                                                                                                                                                  The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                  • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                  • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                  • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                  • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                  • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                  • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                  The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                  • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                  • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                  • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                  • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                  • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                              • $class: 'DayCondition'
                                                                                                                                                                                                                                                • useBuildTime
                                                                                                                                                                                                                                                  Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                  For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                • daySelector
                                                                                                                                                                                                                                                  For which days do you want the build to run?

                                                                                                                                                                                                                                                  Weekends
                                                                                                                                                                                                                                                  Saturday and Sunday
                                                                                                                                                                                                                                                  Weekdays
                                                                                                                                                                                                                                                  Not a weekend
                                                                                                                                                                                                                                                  Select days
                                                                                                                                                                                                                                                  Choose the days for which the build should run

                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                  • $class: 'SelectDays'
                                                                                                                                                                                                                                                    • days
                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                      • day
                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                      • selected
                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                  • $class: 'Weekday'
                                                                                                                                                                                                                                                    • $class: 'Weekend'
                                                                                                                                                                                                                                                  • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                    • expression
                                                                                                                                                                                                                                                      The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                    • label
                                                                                                                                                                                                                                                      The label that will be tested by the regular expression
                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                  • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                      • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                        • projects
                                                                                                                                                                                                                                                          Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                      • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                        • users
                                                                                                                                                                                                                                                          Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                    • exclusiveCause
                                                                                                                                                                                                                                                      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                  • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                    • file
                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                    • baseDir
                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                                                                                                                        • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                          • includes
                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                          • excludes
                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                          • baseDir
                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                            • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                              • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                • $class: 'Workspace'
                                                                                                                                                                                                                                                              • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                • invert
                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                              • $class: 'NeverRun'
                                                                                                                                                                                                                                                                • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                  • allowedNodes
                                                                                                                                                                                                                                                                    • Type: Array / List of String
                                                                                                                                                                                                                                                                • $class: 'Not'
                                                                                                                                                                                                                                                                  • condition
                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                    • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                      • $class: 'And'
                                                                                                                                                                                                                                                                        • conditions
                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                      • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                          The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                      • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                        • token
                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                      • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                        Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                        • buildCause
                                                                                                                                                                                                                                                                          The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                          • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                          • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                          • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                          • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                          • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                          • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                          The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                          • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                          • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                          • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                          • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                          • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                      • $class: 'DayCondition'
                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                        • daySelector
                                                                                                                                                                                                                                                                          For which days do you want the build to run?

                                                                                                                                                                                                                                                                          Weekends
                                                                                                                                                                                                                                                                          Saturday and Sunday
                                                                                                                                                                                                                                                                          Weekdays
                                                                                                                                                                                                                                                                          Not a weekend
                                                                                                                                                                                                                                                                          Select days
                                                                                                                                                                                                                                                                          Choose the days for which the build should run

                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                          • $class: 'SelectDays'
                                                                                                                                                                                                                                                                            • days
                                                                                                                                                                                                                                                                                Array / List of Nested Object
                                                                                                                                                                                                                                                                              • day
                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                              • selected
                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                          • $class: 'Weekday'
                                                                                                                                                                                                                                                                            • $class: 'Weekend'
                                                                                                                                                                                                                                                                          • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                            • expression
                                                                                                                                                                                                                                                                              The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                            • label
                                                                                                                                                                                                                                                                              The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                          • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                              • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                • projects
                                                                                                                                                                                                                                                                                  Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                              • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                • users
                                                                                                                                                                                                                                                                                  Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                          • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                            • file
                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                            • baseDir
                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                              • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                  • $class: 'Workspace'
                                                                                                                                                                                                                                                                                • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                  • includes
                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                  • excludes
                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                  • baseDir
                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                    • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                      • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                        • $class: 'Workspace'
                                                                                                                                                                                                                                                                                      • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                        • invert
                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                      • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                        • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                          • allowedNodes
                                                                                                                                                                                                                                                                                            • Type: Array / List of String
                                                                                                                                                                                                                                                                                        • $class: 'Not'
                                                                                                                                                                                                                                                                                        • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                          • lhs
                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                          • rhs
                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                          • comparator
                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                            • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                              • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                  • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                    • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                      • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                    • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                      • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • value
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • scriptPath
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • scriptText
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • sandbox
                                                                                                                                                                                                                                                                                                        If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • injectEnvironment
                                                                                                                                                                                                                                                                                                        Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • injectProperties

                                                                                                                                                                                                                                                                                                        You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                        For example, the following text:

                                                                                                                                                                                                                                                                                                                BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                        would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                        In the text:

                                                                                                                                                                                                                                                                                                        • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                        • empty lines are ignored
                                                                                                                                                                                                                                                                                                        • lines started by # are ignored
                                                                                                                                                                                                                                                                                                        • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • ontrackLog
                                                                                                                                                                                                                                                                                                        If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                    • $class: 'Or'
                                                                                                                                                                                                                                                                                                    • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                      • command
                                                                                                                                                                                                                                                                                                        Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                      • worstResult
                                                                                                                                                                                                                                                                                                        The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • bestResult
                                                                                                                                                                                                                                                                                                        The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                      • arg1
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • arg2
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • ignoreCase
                                                                                                                                                                                                                                                                                                        Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                    • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                      • fileSet
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • regexp
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • checkConsoleOutput
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                    • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                      • earliest
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • latest
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • useBuildTime
                                                                                                                                                                                                                                                                                                        Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                        For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                    • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                      • variableName
                                                                                                                                                                                                                                                                                                        Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                  • lhs
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • rhs
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • comparator
                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                    • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                      • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                        • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                          • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                            • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                              • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                            • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                              • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • scriptPath
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • scriptText
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • sandbox
                                                                                                                                                                                                                                                                                                                If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • injectEnvironment
                                                                                                                                                                                                                                                                                                                Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • injectProperties

                                                                                                                                                                                                                                                                                                                You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                For example, the following text:

                                                                                                                                                                                                                                                                                                                        BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                        BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                        ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                In the text:

                                                                                                                                                                                                                                                                                                                • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                • empty lines are ignored
                                                                                                                                                                                                                                                                                                                • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • ontrackLog
                                                                                                                                                                                                                                                                                                                If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'Or'
                                                                                                                                                                                                                                                                                                            • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                              • command
                                                                                                                                                                                                                                                                                                                Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                              • worstResult
                                                                                                                                                                                                                                                                                                                The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • bestResult
                                                                                                                                                                                                                                                                                                                The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                              • arg1
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • arg2
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • ignoreCase
                                                                                                                                                                                                                                                                                                                Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                              • fileSet
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • regexp
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                              • earliest
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • latest
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • useBuildTime
                                                                                                                                                                                                                                                                                                                Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                              • variableName
                                                                                                                                                                                                                                                                                                                Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                        • worstResult
                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • bestResult
                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                        • arg1
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • arg2
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • ignoreCase
                                                                                                                                                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                        • fileSet
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                        • earliest
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • latest
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                        • variableName
                                                                                                                                                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                    • timeout
                                                                                                                                                                                                                                                                                                      Timeout in minutes, which will be set if the condition above returns true.
                                                                                                                                                                                                                                                                                                      • Type: long
                                                                                                                                                                                                                                                                                                  • defaultTimeout
                                                                                                                                                                                                                                                                                                    A default timeout in minutes. This value will be used if all condition evaluations fail or return false.
                                                                                                                                                                                                                                                                                                    • Type: long
                                                                                                                                                                                                                                                                                              • operationList
                                                                                                                                                                                                                                                                                                  Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                • $class: 'AbortAndRestartOperation'
                                                                                                                                                                                                                                                                                                  • maxRestarts
                                                                                                                                                                                                                                                                                                    Count of maximum restarts. 0 means without a limit.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'AbortOperation'
                                                                                                                                                                                                                                                                                                  Abort the build. This is a default operation performed if no operations are specified.
                                                                                                                                                                                                                                                                                                  • $class: 'BuildStepOperation'
                                                                                                                                                                                                                                                                                                    Perform a build step or a post-build action as a timeout action.
                                                                                                                                                                                                                                                                                                    This never ensure all build steps and post-build actions works correct.
                                                                                                                                                                                                                                                                                                    • buildstep
                                                                                                                                                                                                                                                                                                      • Type: Build Step (hudson.tasks.BuildStep)
                                                                                                                                                                                                                                                                                                    • continueEvenFailed
                                                                                                                                                                                                                                                                                                      Continue subsequent timeout actions even when the build step failed. If unchecked, subsequent timeout actions is not executed, and the build will be marked as failure.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • createLauncher
                                                                                                                                                                                                                                                                                                      Build steps like "Execute shell", "Execute Windows batch command" and so on, requires Launcher object to execute an external program. Build Timeout does not provide Launcher for build steps by default and those build steps fail. Checking here provides the build step a new created Launcher. You should not check here as long as the build step can run without this (that is, it does not require an external program).
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                  • $class: 'FailOperation'
                                                                                                                                                                                                                                                                                                    The build will be marked as failed.
                                                                                                                                                                                                                                                                                                    • $class: 'WriteDescriptionOperation'
                                                                                                                                                                                                                                                                                                      Writing the build description.
                                                                                                                                                                                                                                                                                                      • description
                                                                                                                                                                                                                                                                                                        A description to set. {0} will be replaced with timeout minutes.
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'BuildStepsFromJsonBuilder'
                                                                                                                                                                                                                                                                                                • $class: 'BuildoutBuilder'
                                                                                                                                                                                                                                                                                                  • pythonName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • buildoutCfg
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • nature
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • ignoreExitCode
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                • byteguardGreet
                                                                                                                                                                                                                                                                                                  • token
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • task_id
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CFLaunchBuilder'
                                                                                                                                                                                                                                                                                                  • cfComposition
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • setCFVars
                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                    • vars
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • Variable
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • Value
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CIMessageBuilder'
                                                                                                                                                                                                                                                                                                  • providerData (optional)
                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                    • activeMQPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • messageProperties (optional)

                                                                                                                                                                                                                                                                                                        KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • messageType (optional)

                                                                                                                                                                                                                                                                                                        Type of CI message to be sent.

                                                                                                                                                                                                                                                                                                        • Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                    • activeMQSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • selector (optional)

                                                                                                                                                                                                                                                                                                        JMS selector to choose messages that will fire the trigger.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • fedmsgPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                    • fedmsgSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • rabbitMQPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • fedoraMessaging (optional)
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • schema (optional)

                                                                                                                                                                                                                                                                                                        Path to message schema.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • severity (optional)

                                                                                                                                                                                                                                                                                                        Severity of the message.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                    • rabbitMQSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: 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)
                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                    • activeMQPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • messageProperties (optional)

                                                                                                                                                                                                                                                                                                        KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • messageType (optional)

                                                                                                                                                                                                                                                                                                        Type of CI message to be sent.

                                                                                                                                                                                                                                                                                                        • Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                    • activeMQSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • selector (optional)

                                                                                                                                                                                                                                                                                                        JMS selector to choose messages that will fire the trigger.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • fedmsgPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                    • fedmsgSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • rabbitMQPublisher
                                                                                                                                                                                                                                                                                                      • failOnError (optional)

                                                                                                                                                                                                                                                                                                        Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • fedoraMessaging (optional)
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • messageContent (optional)

                                                                                                                                                                                                                                                                                                        Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • schema (optional)

                                                                                                                                                                                                                                                                                                        Path to message schema.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • severity (optional)

                                                                                                                                                                                                                                                                                                        Severity of the message.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                    • rabbitMQSubscriber
                                                                                                                                                                                                                                                                                                      • checks (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • field
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • expectedValue
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • name (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • overrides (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • topic (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • queue (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)

                                                                                                                                                                                                                                                                                                        Value (in minutes) to wait for a message.

                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • variable (optional)

                                                                                                                                                                                                                                                                                                        Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CToolBuilder'
                                                                                                                                                                                                                                                                                                  Executes a tool of the CMake-suite with arbitrary command-line arguments.
                                                                                                                                                                                                                                                                                                  Useful to run cmake in script mode (cmake -P <script file>) or command mode (cmake -E <command>).
                                                                                                                                                                                                                                                                                                  • installationName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • arguments (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • ignoredExitCodes (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • toolId (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • workingDir (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • generateCache
                                                                                                                                                                                                                                                                                                  Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).
                                                                                                                                                                                                                                                                                                  • caches
                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                    • type
                                                                                                                                                                                                                                                                                                      • Values: A2L, ELF, BUS, MODEL, SERVICE
                                                                                                                                                                                                                                                                                                    • filePath
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • dbChannel
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • clear
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                • $class: 'CallFunction'
                                                                                                                                                                                                                                                                                                  Call a function You can choose:
                                                                                                                                                                                                                                                                                                  • Function name
                                                                                                                                                                                                                                                                                                  • Function Arguments
                                                                                                                                                                                                                                                                                                  • functionName (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • argumentList (optional)
                                                                                                                                                                                                                                                                                                    • Type: Array / List of String
                                                                                                                                                                                                                                                                                                  • argument (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CallOtherJenkinsBuilder'
                                                                                                                                                                                                                                                                                                  • hostName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • jobName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • span
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • retry
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • userName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • password
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • parameters
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CaptureIOSDeviceScreenshot'
                                                                                                                                                                                                                                                                                                  Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).
                                                                                                                                                                                                                                                                                                  • url
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • cloudTestServerID
                                                                                                                                                                                                                                                                                                    Select the server to download iOSAppInstaller.zip from.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • additionalOptions
                                                                                                                                                                                                                                                                                                    If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • carbonetes
                                                                                                                                                                                                                                                                                                  • name
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • credentialsId (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • engineTimeout (optional)
                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                  • failBuildOnPluginError (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • failBuildOnPolicyEvaluationFailResult (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • image (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • policyBundleID (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • registryURI (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • carl
                                                                                                                                                                                                                                                                                                  • installationName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • sourcePath
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • applicationName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • archivePdf (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • displayLog (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • logPath (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • outputPath (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • qualityGate (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • castecho
                                                                                                                                                                                                                                                                                                  • installationName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • sourcePath
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • applicationName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • displayLog (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • logPath (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • outputPath (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • qualityGate (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • venafiVcertRequestCertificate
                                                                                                                                                                                                                                                                                                  • connectorName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • zoneConfigName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • commonName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • privKeyOutput
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • certOutput
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • certChainOutput
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • country (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • dnsNames (optional)
                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                    • hostName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • emailAddresses (optional)
                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                    • address
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • ipAddresses (optional)
                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                    • address
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • keyType (optional)
                                                                                                                                                                                                                                                                                                    • Values: RSA, ECDSA
                                                                                                                                                                                                                                                                                                  • locality (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • organization (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • organizationalUnit (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • province (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • changeAsmVer
                                                                                                                                                                                                                                                                                                  This build step can be used to change the version in the AssemblyInfo.cs file from a .NET Project, it's going to find every AssemblyInfo.cs file in the workspace and change the version from [AssemblyVersion] and [AssemblyFileVersion] attributes. It's recommended to use this plugin with the auto-generated AssemblyInfo.cs from VisualStudio.
                                                                                                                                                                                                                                                                                                  • versionPattern
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyCompany (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyCopyright (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyCulture (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyDescription (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyFile (optional)
                                                                                                                                                                                                                                                                                                    Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyProduct (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyTitle (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • assemblyTrademark (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • regexPattern (optional)
                                                                                                                                                                                                                                                                                                    Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • replacementPattern (optional)
                                                                                                                                                                                                                                                                                                    Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'ChangeEventBuilder'
                                                                                                                                                                                                                                                                                                  Create Change Events on PagerDuty services as Jenkins build steps.
                                                                                                                                                                                                                                                                                                  • integrationKey
                                                                                                                                                                                                                                                                                                    This is the 32 character Integration Key for an Integration on a Service.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • summaryText (optional)
                                                                                                                                                                                                                                                                                                    This is an alternate summary text, that can be passed onto Pager duty change events. If omitted it will default to current build's fullDisplayName.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • chatterPost
                                                                                                                                                                                                                                                                                                  Simple step for posting a Chatter buildUrlTitle/body to a specified channel or the user's wall.
                                                                                                                                                                                                                                                                                                  Usage Example:
                                                                                                                                                                                                                                                                                                  postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
                                                                                                                                                                                                                                                                                                  • credentialsId
                                                                                                                                                                                                                                                                                                    Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.

                                                                                                                                                                                                                                                                                                    If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.

                                                                                                                                                                                                                                                                                                    See Identity Confirmation in the salesforce.com online help for more information.

                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • body
                                                                                                                                                                                                                                                                                                    The body text for your Chatter post
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • buildUrlTitle (optional)
                                                                                                                                                                                                                                                                                                    The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • recordId (optional)
                                                                                                                                                                                                                                                                                                    Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • server (optional)
                                                                                                                                                                                                                                                                                                    If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CheckGate'
                                                                                                                                                                                                                                                                                                  • pipelineId
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • stageName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • versionId
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • fatal
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'CheckGateBuilder'
                                                                                                                                                                                                                                                                                                  • project
                                                                                                                                                                                                                                                                                                    Select project.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • gate
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'ChefBuilderConfiguration'
                                                                                                                                                                                                                                                                                                  • url
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • sinatraurl
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • filter
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • username
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • port
                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • privatekey
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • parallel
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • fail
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                • chlAtuoAction
                                                                                                                                                                                                                                                                                                  • content
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • browserString
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • runScriptOnly
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • rootPath
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • libPath
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'ChrootBuilder'
                                                                                                                                                                                                                                                                                                  • chrootName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • ignoreExit
                                                                                                                                                                                                                                                                                                    The build will always succeed.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • additionalPackages
                                                                                                                                                                                                                                                                                                    Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • packagesFile
                                                                                                                                                                                                                                                                                                    Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • clear
                                                                                                                                                                                                                                                                                                    Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • loginAsRoot
                                                                                                                                                                                                                                                                                                    When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • noUpdate
                                                                                                                                                                                                                                                                                                    When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • forceInstall
                                                                                                                                                                                                                                                                                                    This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                • $class: 'CifsBuilderPlugin'
                                                                                                                                                                                                                                                                                                  • publishers
                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                    • configName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • verbose
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • transfers
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • sourceFiles
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • remoteDirectory
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • removePrefix
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • remoteDirectorySDF
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • flatten
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • cleanRemote
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • noDefaultExcludes
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • makeEmptyDirs
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • patternSeparator
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • useWorkspaceInPromotion
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • usePromotionTimestamp
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • retry
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • retries
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • retryDelay
                                                                                                                                                                                                                                                                                                        • Type: long
                                                                                                                                                                                                                                                                                                    • label
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • label
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                  • continueOnError
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • failOnError
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • alwaysPublishFromMaster
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • masterNodeName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • paramPublish
                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                    • parameterName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                • $class: 'ClangScanBuildBuilder'
                                                                                                                                                                                                                                                                                                  Use this option to execute clang scan-build against and XCode project.
                                                                                                                                                                                                                                                                                                  • target
                                                                                                                                                                                                                                                                                                    Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • targetSdk
                                                                                                                                                                                                                                                                                                    This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:
                                                                                                                                                                                                                                                                                                    xcodebuild -showsdks

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

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

                                                                                                                                                                                                                                                                                                    -derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • outputFolderName
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • googleStorageUpload
                                                                                                                                                                                                                                                                                                  • credentialsId
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • bucket
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • pattern
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • pathPrefix (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • sharedPublicly (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • showInline (optional)
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                • dotnetClean
                                                                                                                                                                                                                                                                                                  The dotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
                                                                                                                                                                                                                                                                                                  • configuration (optional)
                                                                                                                                                                                                                                                                                                    Defines the build configuration. The default for most projects is 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.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • framework (optional)
                                                                                                                                                                                                                                                                                                    The framework that was specified at build time. The framework must be defined in the project file. If you specified the framework at build time, you must specify the framework when cleaning.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • nologo (optional)
                                                                                                                                                                                                                                                                                                    Doesn't display the startup banner or the copyright message.

                                                                                                                                                                                                                                                                                                    Available since: .NET Core SDK 3.0
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • option (optional)
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • options (optional)
                                                                                                                                                                                                                                                                                                    • Type: Array / List of String
                                                                                                                                                                                                                                                                                                  • optionsString (optional)
                                                                                                                                                                                                                                                                                                    For more information about these options, see the MSBuild Command-Line Reference.
                                                                                                                                                                                                                                                                                                    If targets and/or properties are also configured, those will be passed after these options.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • outputDirectory (optional)
                                                                                                                                                                                                                                                                                                    The directory that contains the build artifacts to clean. If you specified the framework when the project was built, that same framework should also be specified for this cleanup action.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • project (optional)
                                                                                                                                                                                                                                                                                                    The MSBuild project or solution to clean. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • properties (optional)
                                                                                                                                                                                                                                                                                                    • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                  • propertiesString (optional)
                                                                                                                                                                                                                                                                                                    Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • runtime (optional)
                                                                                                                                                                                                                                                                                                    Cleans the output folder of the specified runtime. This is used when a self-contained deployment was created.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • sdk (optional)
                                                                                                                                                                                                                                                                                                    Name of a .NET SDK to use so that dotnet will be in the path.
                                                                                                                                                                                                                                                                                                    If the default is specified, you either need to use the With .NET element (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.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • showSdkInfo (optional)
                                                                                                                                                                                                                                                                                                    If enabled, 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.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • shutDownBuildServers (optional)
                                                                                                                                                                                                                                                                                                    If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
                                                                                                                                                                                                                                                                                                    Note: If this is not specified, a build that causes such a build server to be started may hang until 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).

                                                                                                                                                                                                                                                                                                    Available since: .NET Core SDK 2.1
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • specificSdkVersion (optional)
                                                                                                                                                                                                                                                                                                    Depending on the platform, the 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.
                                                                                                                                                                                                                                                                                                    By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
                                                                                                                                                                                                                                                                                                    Note: This will silently overwrite any global.json already present in the current directory.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • unstableIfWarnings (optional)
                                                                                                                                                                                                                                                                                                    If this is set and the build completes successfully with warnings, the build will be marked as unstable.
                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                  • verbosity (optional)
                                                                                                                                                                                                                                                                                                    Sets the MSBuild verbosity level.
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                  • workDirectory (optional)
                                                                                                                                                                                                                                                                                                    The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                • examCleanTarget
                                                                                                                                                                                                                                                                                                  • validNetwork
                                                                                                                                                                                                                                                                                                    • username
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • password
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • projectId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • filepath
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'ClifBuilder'
                                                                                                                                                                                                                                                                                                    • clifName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • clifOpts
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • testPlanFile
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • reportDir
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CloudBuildBuilder'
                                                                                                                                                                                                                                                                                                    This build step invokes Google Cloud Build.
                                                                                                                                                                                                                                                                                                    • input
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • credentialsId
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • request
                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                        • file
                                                                                                                                                                                                                                                                                                          • filename
                                                                                                                                                                                                                                                                                                            The path to the YAML build request file to pass to Google Cloud Build.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • inline
                                                                                                                                                                                                                                                                                                          • request
                                                                                                                                                                                                                                                                                                            The YAML Build Request to pass to Google Cloud Build.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                      • source (optional)
                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                        • local
                                                                                                                                                                                                                                                                                                          • path
                                                                                                                                                                                                                                                                                                            The source to use in the build request. This may be either:
                                                                                                                                                                                                                                                                                                            • A path to a file within the workspace. The file must be a compressed gzipped tarball (.tgz or .tar.gz) or zip file (.zip), or
                                                                                                                                                                                                                                                                                                            • A path to a directory within the workspace. The contents of the directory will be archived as a gzipped tarball (.tgz) and uploaded to a temporary Cloud Storage bucket.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • repo
                                                                                                                                                                                                                                                                                                          • branch (optional)
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • commit (optional)
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • projectId (optional)
                                                                                                                                                                                                                                                                                                            ID of the project that owns the repo. If omitted, the project ID requesting the build is assumed.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • repoName (optional)
                                                                                                                                                                                                                                                                                                            Name of the repo. If omitted, the name "default" is assumed.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • tag (optional)
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • storage
                                                                                                                                                                                                                                                                                                          • bucket
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • object
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                      • substitutionList (optional)
                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                        • items
                                                                                                                                                                                                                                                                                                          User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                          • key
                                                                                                                                                                                                                                                                                                            The name of the user-defined substitution. This must begin with an underscore (_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                            The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                      • substitutions (optional)
                                                                                                                                                                                                                                                                                                        • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                  • pushToCloudFoundry
                                                                                                                                                                                                                                                                                                    • target
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • organization
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cloudSpace
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • manifestChoice (optional)
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • appName (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • appPath (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • buildpack (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • command (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • domain (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • envVars (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • key
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • value
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • hostname (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • instances (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • manifestFile (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • memory (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • noRoute (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • servicesNames (optional)
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • name
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • stack (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • timeout (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • value (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • pluginTimeout (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • selfSigned (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • servicesToCreate (optional)
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • name
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • type
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • plan
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • resetService (optional)
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                  • cloudhubDeployer
                                                                                                                                                                                                                                                                                                    • environmentId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • orgId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • appName
                                                                                                                                                                                                                                                                                                      The application name identifies your application not only in Runtime Manager but also in the public cloudhub.io domain. For example, an application named myapplication is accessible at http://myapplication.cloudhub.io. To avoid domain conflicts, the application name must be globally unique across CloudHub.The application name can contain between 3 and 42 alphanumeric characters (a-z, A-Z, 0-9) and dashes (-). They cannot contain spaces or other characters.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • muleVersion
                                                                                                                                                                                                                                                                                                      The runtime version must be the same Mule version used to develop your application.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • filePath
                                                                                                                                                                                                                                                                                                      Workspace-relative path of the artifact file to upload (it should resolve to a single file). Can use wildcards like module/dist/**/*.jar, See the @includes of Ant fileset for the exact format. Examples: File, like target/my-mule-app.jar or target/**/*.jar : The jar file will be uploaded to cloudhub.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • credentialsId (optional)
                                                                                                                                                                                                                                                                                                      Jenkins credentials containing The Anypoint Platform account username and password with sufficient access to perform deployment related activities on CloudHub.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • requestMode (optional)
                                                                                                                                                                                                                                                                                                      Type of Operation to perform on CloudHub. CREATE - Deploy/Create new application UPDATE - Update application with new package and settings provided. UPDATE_FILE - Update just the zip/jar file of application, rest all settings ignored. CREATE_OR_UPDATE - Deploy/Create new application(if not already present) or update the existing application. RESTART - Restart the application already present. DELETE - Delete the application.
                                                                                                                                                                                                                                                                                                      • Values: CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETE
                                                                                                                                                                                                                                                                                                    • region (optional)
                                                                                                                                                                                                                                                                                                      If you have global deployment enabled on your account, you can change the deployment region.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • autoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • autoScalePolicyName (optional)
                                                                                                                                                                                                                                                                                                        The auto scaling policy name.
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • enableAutoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                      • id (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • maxScale (optional)
                                                                                                                                                                                                                                                                                                        The maximum number of workers or size of workers for auto scaling. Allowed Values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • minScale (optional)
                                                                                                                                                                                                                                                                                                        The minimum number of workers or size of workers for auto scaling. Allowed values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleBasedOn (optional)
                                                                                                                                                                                                                                                                                                        The metric based on which auto scaling policy scales. Allowed values: CPU, MEMORY
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • scaleDown (optional)
                                                                                                                                                                                                                                                                                                        • Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
                                                                                                                                                                                                                                                                                                      • scaleDownNextScaleWaitMins (optional)
                                                                                                                                                                                                                                                                                                        Number of minutes to wait before applying new scale down policy.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleDownPeriodCount (optional)
                                                                                                                                                                                                                                                                                                        The time in minutes to monitor the CPU/memory for low usage before scaling down.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleDownValue (optional)
                                                                                                                                                                                                                                                                                                        The CPU or memory usage below which scale down policy will take effect.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleType (optional)
                                                                                                                                                                                                                                                                                                        The scale type of the auto scaling policy. Allowed values: WORKER_COUNT, WORKER_SIZE
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • scaleUp (optional)
                                                                                                                                                                                                                                                                                                        • Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
                                                                                                                                                                                                                                                                                                      • scaleUpNextScaleWaitMins (optional)
                                                                                                                                                                                                                                                                                                        Number of minutes to wait before applying new scale up policy.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleUpPeriodCount (optional)
                                                                                                                                                                                                                                                                                                        The time in minutes to monitor the CPU/memory for high usage before scaling up.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                      • scaleUpValue (optional)
                                                                                                                                                                                                                                                                                                        The CPU or memory usage above which scale up policy will take effect.
                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                    • autoStart (optional)
                                                                                                                                                                                                                                                                                                      Check this flag to autostart the application after it is deployed
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • debugMode (optional)
                                                                                                                                                                                                                                                                                                      Use this to log additional details/info from the http requests.
                                                                                                                                                                                                                                                                                                      • Values: ENABLED, DISABLED
                                                                                                                                                                                                                                                                                                    • enableAutoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • envVars (optional)
                                                                                                                                                                                                                                                                                                      you can specify properties (key-value pairs) that the application uses during deployment and while running.
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • key (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • value (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • ignoreGlobalSettings (optional)
                                                                                                                                                                                                                                                                                                      If checked settings from global configuration will be used that are under manage jenkins.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • logLevels (optional)
                                                                                                                                                                                                                                                                                                      You can configure the logging level (DEBUG, WARN, ERROR, or INFO) for the application
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • levelCategory (optional)
                                                                                                                                                                                                                                                                                                        • Values: DEBUG, WARN, ERROR, INFO
                                                                                                                                                                                                                                                                                                      • packageName (optional)
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • loggingNgEnabled (optional)
                                                                                                                                                                                                                                                                                                      Check this if you want to use your own logging solution using Log4j configuration.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • monitoringAutoRestart (optional)
                                                                                                                                                                                                                                                                                                      CloudHub automatically restarts your application when the monitoring system discovers an issue.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • monitoringEnabled (optional)
                                                                                                                                                                                                                                                                                                      Use Anypoint Monitoring and Visualizer for Mule applications running on supported versions of Mule.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • objectStoreV1 (optional)
                                                                                                                                                                                                                                                                                                      Object Store v2 is enabled by default in Mule 4. In Mule 3, select this option to use Object Store v1.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • persistentQueues (optional)
                                                                                                                                                                                                                                                                                                      You can use persistent queues on your application to store data in an input queue to disk. Persistent queues protect against message loss and enable you to distribute workloads across a set of workers.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • persistentQueuesEncrypted (optional)
                                                                                                                                                                                                                                                                                                      If you enable persistent queues, you can optionally encrypt the data stored in the input queue on disk.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • timeoutConnection (optional)
                                                                                                                                                                                                                                                                                                      Max time to try before failing the request.
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • timeoutResponse (optional)
                                                                                                                                                                                                                                                                                                      Max time to wait for response before failing the request.
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • verifyDeployments (optional)
                                                                                                                                                                                                                                                                                                      Verify if API is stated after deployment.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • verifyIntervalInSeconds (optional)
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • workerAmount (optional)
                                                                                                                                                                                                                                                                                                      No of workers to run for API.
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • workerCpu (optional)
                                                                                                                                                                                                                                                                                                      Compute Capacity for each worker(vCores). Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 2 or 16
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • workerMemory (optional)
                                                                                                                                                                                                                                                                                                      Heap memory (Or Ram) for each worker. Check MuleSoft Documentation for available sizes (worker-size-and-vcores. Example Values :- "500 MB", "1.5 GB" or "32 GB"
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • workerType (optional)
                                                                                                                                                                                                                                                                                                      Type of worker to use "Micro", "Small", "Medium" or "Large". Check MuleSoft Documentation for additional details.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • workerWeight (optional)
                                                                                                                                                                                                                                                                                                      Weight for worker type. Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 0.2 or 1
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CloudManagerBuilder'
                                                                                                                                                                                                                                                                                                    • program (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • pipeline (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CloudShellConfig'
                                                                                                                                                                                                                                                                                                    • buildStep
                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                      • $class: 'StartSandbox'
                                                                                                                                                                                                                                                                                                        • blueprintName
                                                                                                                                                                                                                                                                                                          Enter the name or id of a CloudShell blueprint.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • sandboxDuration
                                                                                                                                                                                                                                                                                                          The sandbox duration in minuets.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • maxWaitForSandboxAvailability
                                                                                                                                                                                                                                                                                                          Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                        • setupTimeout
                                                                                                                                                                                                                                                                                                          Enter the number of minutes to wait for the sandbox setup to complete
                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                        • params (optional)
                                                                                                                                                                                                                                                                                                          Blueprint Parameter in this syntax: "input1=my_name; input2=30"
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • sandboxDomain (optional)
                                                                                                                                                                                                                                                                                                          Sandbox will be created in the following domain.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • sandboxName (optional)
                                                                                                                                                                                                                                                                                                          Sandboxes will be created with this name instead of the blueprint name.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CmakeBuilder'
                                                                                                                                                                                                                                                                                                    Uses CMake to generate build-scripts and can run these.
                                                                                                                                                                                                                                                                                                    This causes Jenkins to invoke cmake -G with the given options.
                                                                                                                                                                                                                                                                                                    Any non-zero exit code during build-script generation causes Jenkins to mark the build as a failure.
                                                                                                                                                                                                                                                                                                    It also can expose the CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
                                                                                                                                                                                                                                                                                                    • installationName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • buildDir (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • buildType (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cleanBuild (optional)
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • cmakeArgs (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • generator (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • preloadScript (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sourceDir (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • steps (optional)
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • args (optional)
                                                                                                                                                                                                                                                                                                        Specify arguments to pass to the build tool or to 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),
                                                                                                                                                                                                                                                                                                        Most of the time, you will want to leave this empty (to call the default build target) or you will specify just some build target names here.
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • envVars (optional)
                                                                                                                                                                                                                                                                                                        Specify extra environment variables to pass to the build tool as key-value pairs here.
                                                                                                                                                                                                                                                                                                        Each entry must be on its own line, for example:
                                                                                                                                                                                                                                                                                                        DESTDIR=${WORKSPACE}/artifacts/dir
                                                                                                                                                                                                                                                                                                        KEY=VALUE
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • withCmake (optional)
                                                                                                                                                                                                                                                                                                        Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
                                                                                                                                                                                                                                                                                                        • Leave unchecked for minimal performance overhead.
                                                                                                                                                                                                                                                                                                        • Make it checked, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                  • $class: 'CocoaPodsBuilder'
                                                                                                                                                                                                                                                                                                    • cleanpods
                                                                                                                                                                                                                                                                                                      If checked the "pod" folder will be deleted before updating the pods
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                  • $class: 'CodeBuilder'
                                                                                                                                                                                                                                                                                                    • credentialsType
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • proxyHost
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • proxyPort
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • awsAccessKey
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • awsSecretKey
                                                                                                                                                                                                                                                                                                      • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                    • awsSessionToken
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • region
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • projectName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sourceVersion
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sseAlgorithm
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sourceControlType
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • localSourcePath
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • workspaceSubdir
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • gitCloneDepthOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • reportBuildStatusOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • secondarySourcesOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • secondarySourcesVersionOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactTypeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactLocationOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactNameOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactNamespaceOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactPackagingOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactPathOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • artifactEncryptionDisabledOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • overrideArtifactName
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • secondaryArtifactsOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • envVariables
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • envParameters
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • buildSpecFile
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • buildTimeoutOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sourceTypeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • sourceLocationOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • environmentTypeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • imageOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • computeTypeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cacheTypeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cacheLocationOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cacheModesOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cloudWatchLogsStatusOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cloudWatchLogsGroupNameOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cloudWatchLogsStreamNameOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • s3LogsStatusOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • s3LogsEncryptionDisabledOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • s3LogsLocationOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • certificateOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • serviceRoleOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • insecureSslOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • privilegedModeOverride
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • cwlStreamingDisabled
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • exceptionFailureMode
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • downloadArtifacts
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • downloadArtifactsRelativePath
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CodeCoverageBuilder'
                                                                                                                                                                                                                                                                                                    • connectionId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • analysisPropertiesPath
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • analysisProperties
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • codescene
                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                      Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • deltaAnalysisUrl
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • repository
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • analyzeBranchDiff (optional)
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • analyzeLatestIndividually (optional)
                                                                                                                                                                                                                                                                                                      Commits not seen in previous successful builds will be used for separate delta analyses.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • baseRevision (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • couplingThresholdPercent (optional)
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • failOnDecliningCodeHealth (optional)
                                                                                                                                                                                                                                                                                                      Check this option to mark the build as unstable if the Code Health of a hotspot declines.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • failOnFailedGoal (optional)
                                                                                                                                                                                                                                                                                                      Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • letBuildPassOnFailedAnalysis (optional)
                                                                                                                                                                                                                                                                                                      By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • markBuildAsUnstable (optional)
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • originUrl (optional)
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • riskThreshold (optional)
                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                    • useBiomarkers (optional)
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                  • $class: 'CodeStreamBuilder'
                                                                                                                                                                                                                                                                                                    • serverUrl
                                                                                                                                                                                                                                                                                                      vRealize Automation host.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • userName
                                                                                                                                                                                                                                                                                                      User name
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • password
                                                                                                                                                                                                                                                                                                      Password
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • tenant
                                                                                                                                                                                                                                                                                                      Tenant
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • pipelineName
                                                                                                                                                                                                                                                                                                      CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • waitExec
                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                    • pipelineParams
                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                      • value
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • name
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CodefreshPipelineBuilder'
                                                                                                                                                                                                                                                                                                    • selectPipeline
                                                                                                                                                                                                                                                                                                      Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • cfPipeline
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                      • cfBranch
                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                    • setCFVars
                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                      • vars
                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                        • Variable
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • Value
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CommentsRemoverBuilder'
                                                                                                                                                                                                                                                                                                    • filename
                                                                                                                                                                                                                                                                                                      Name of the input file to have comments removed from
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • language
                                                                                                                                                                                                                                                                                                      Language of the input file - helps locate comments
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • outputDir
                                                                                                                                                                                                                                                                                                      After execution the result will be in this directory in the workspace
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                  • $class: 'CompoundBuilder'
                                                                                                                                                                                                                                                                                                    • role
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • number
                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                    • actualBuilder
                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                      • $class: 'A3Builder'
                                                                                                                                                                                                                                                                                                        • project_file
                                                                                                                                                                                                                                                                                                          Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
                                                                                                                                                                                                                                                                                                          (Note: a³ workspace files (also .apx) are not supported as input.)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • analysis_ids
                                                                                                                                                                                                                                                                                                          The following values are allowed:
                                                                                                                                                                                                                                                                                                          • Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
                                                                                                                                                                                                                                                                                                          • No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • pedantic_level
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • export_a3apxworkspace
                                                                                                                                                                                                                                                                                                          Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • copy_report_file
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • copy_result_file
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • skip_a3_analysis
                                                                                                                                                                                                                                                                                                          This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • $class: 'ACSDeploymentBuilder'
                                                                                                                                                                                                                                                                                                        • context
                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                          • azureCredentialsId
                                                                                                                                                                                                                                                                                                            The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • resourceGroupName
                                                                                                                                                                                                                                                                                                            Resource group of the target Azure Container Service.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • containerService
                                                                                                                                                                                                                                                                                                            The name of the Azure Container Service. Refer to the following documentation on how to setup Azure Container Service:
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • sshCredentialsId

                                                                                                                                                                                                                                                                                                            The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).

                                                                                                                                                                                                                                                                                                            The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.

                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • configFilePaths

                                                                                                                                                                                                                                                                                                            The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.

                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • containerRegistryCredentials (optional)
                                                                                                                                                                                                                                                                                                            All the credentials needed for pulling images from private repositories. Specify multiple entries if your deployments need to pull images from multiple, private repositories that require authentication.
                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                            • url
                                                                                                                                                                                                                                                                                                              URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • credentialsId
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                          • dcosDockerCredenditalsPathShared (optional)

                                                                                                                                                                                                                                                                                                            Determine if the Docker credentials archive upload path specified above is shared among all the agents.

                                                                                                                                                                                                                                                                                                            To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.

                                                                                                                                                                                                                                                                                                            Check this option if the Docker credentials archive upload path is a shared storage path.

                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • dcosDockerCredentialsPath (optional)

                                                                                                                                                                                                                                                                                                            The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.

                                                                                                                                                                                                                                                                                                            If not specified, the plugin will generate a path specific for the build with the following pattern.

                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            /home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>

                                                                                                                                                                                                                                                                                                            The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.

                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            "uris":  [
                                                                                                                                                                                                                                                                                                                "file://<filled-path>/docker.tar.gz"
                                                                                                                                                                                                                                                                                                            ]

                                                                                                                                                                                                                                                                                                            The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.

                                                                                                                                                                                                                                                                                                            Note that if an archive exists in the target path already, the build will overwrite that file.

                                                                                                                                                                                                                                                                                                            Reference: Marathon: Using a Private Docker Registry

                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • enableConfigSubstitution (optional)
                                                                                                                                                                                                                                                                                                            Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.

                                                                                                                                                                                                                                                                                                            This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.

                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • secretName (optional)
                                                                                                                                                                                                                                                                                                            The secret name that you can use in the Kubernetes Deployment configuration for the imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)

                                                                                                                                                                                                                                                                                                            If left blank, the plugin will generate a name based on the build name.

                                                                                                                                                                                                                                                                                                            The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.

                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            apiVersion: extensions/v1beta1
                                                                                                                                                                                                                                                                                                            kind: Deployment
                                                                                                                                                                                                                                                                                                            metadata:
                                                                                                                                                                                                                                                                                                              name: nginx
                                                                                                                                                                                                                                                                                                            spec:
                                                                                                                                                                                                                                                                                                              replicas: 1
                                                                                                                                                                                                                                                                                                              template:
                                                                                                                                                                                                                                                                                                                metadata:
                                                                                                                                                                                                                                                                                                                  labels:
                                                                                                                                                                                                                                                                                                                    app: nginx
                                                                                                                                                                                                                                                                                                                spec:
                                                                                                                                                                                                                                                                                                                  containers:
                                                                                                                                                                                                                                                                                                                  - name: nginx
                                                                                                                                                                                                                                                                                                                    image: some.private.registry.domain/nginx
                                                                                                                                                                                                                                                                                                                    ports:
                                                                                                                                                                                                                                                                                                                    - containerPort: 80
                                                                                                                                                                                                                                                                                                                  imagePullSecrets:
                                                                                                                                                                                                                                                                                                                  - name: $KUBERNETES_SECRET_NAME
                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                            Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.

                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • secretNamespace (optional)
                                                                                                                                                                                                                                                                                                            The Kubernetes namespace in which the secrets will be created with the credentials configured below.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • swarmRemoveContainersFirst (optional)
                                                                                                                                                                                                                                                                                                            Stop and remove containers first.
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                      • qualysAPIStaticAssessment
                                                                                                                                                                                                                                                                                                        • freeUserType
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • platform (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • apiServer (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • credsId (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • useProxy (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • proxyServer (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • proxyPort (optional)
                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                        • proxyCredentialsId (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • swaggerPath (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • apiId (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • isFailOnGrade (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • grade (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • isFailOnSecurityGroup (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • securityGroupCount (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • securityCriticality (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • isFailOnDataGroup (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • dataGroupCount (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • dataCriticality (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • isFailOnViolationGroup (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • violationGroupCount (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • violationCriticality (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • token (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • cfyAzureArm
                                                                                                                                                                                                                                                                                                        • azureCredentialsId (optional)

                                                                                                                                                                                                                                                                                                          The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • credentialsId (optional)

                                                                                                                                                                                                                                                                                                          The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • debugOutput (optional)
                                                                                                                                                                                                                                                                                                          If checked, then printed Cloudify events and logs will include debug-level records.
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • deploymentId (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • echoEnvData (optional)

                                                                                                                                                                                                                                                                                                          If checked, then the created environment's data will be printed to the job's log.

                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • echoInputs (optional)
                                                                                                                                                                                                                                                                                                          If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • envDataLocation (optional)

                                                                                                                                                                                                                                                                                                          Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • location (optional)

                                                                                                                                                                                                                                                                                                          The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • parameters (optional)

                                                                                                                                                                                                                                                                                                          YAML/JSON of parameters to pass to the template.

                                                                                                                                                                                                                                                                                                          • Type: java.util.Map<java.lang.String, java.lang.Object>
                                                                                                                                                                                                                                                                                                        • parametersAsString (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • parametersFile (optional)

                                                                                                                                                                                                                                                                                                          Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • resourceGroupName (optional)

                                                                                                                                                                                                                                                                                                          Name of resource group to create for the template.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • templateFile (optional)

                                                                                                                                                                                                                                                                                                          Workspace-relative path of the ARM template file.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • tenant (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • $class: 'AWSEBBuilder'
                                                                                                                                                                                                                                                                                                        • extensions
                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                          • awsRegion
                                                                                                                                                                                                                                                                                                            AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
                                                                                                                                                                                                                                                                                                            • Values: GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1
                                                                                                                                                                                                                                                                                                          • awsRegionText
                                                                                                                                                                                                                                                                                                            AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • credentialsString
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • credentialsText
                                                                                                                                                                                                                                                                                                            Use a credentials name that will be resolved during the build.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • applicationName
                                                                                                                                                                                                                                                                                                            AWS EB Application Name (e.g.: "myapp")
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • versionLabelFormat
                                                                                                                                                                                                                                                                                                            How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • versionDescriptionFormat
                                                                                                                                                                                                                                                                                                            Sets the description of the version to be published. Jenkins environment variables are supported such as ${GIT_BRANCH} - ${BUILD_TAG}
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • failOnError
                                                                                                                                                                                                                                                                                                            If any of the environments fail to update, or if there are no matching environments then fail the build.
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • extensions
                                                                                                                                                                                                                                                                                                              Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                            • $class: 'AWSEBElasticBeanstalkSetup'
                                                                                                                                                                                                                                                                                                            • $class: 'AWSEBS3Setup'
                                                                                                                                                                                                                                                                                                              • bucketName
                                                                                                                                                                                                                                                                                                                S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • bucketRegion
                                                                                                                                                                                                                                                                                                                S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • keyPrefix
                                                                                                                                                                                                                                                                                                                Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • rootObject

                                                                                                                                                                                                                                                                                                                Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.

                                                                                                                                                                                                                                                                                                                It could be either a path to a zip file or a directory.

                                                                                                                                                                                                                                                                                                                If its a directory, includes and excludes are used to build the zip file

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • overwriteExistingFile
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • useTransferAcceleration
                                                                                                                                                                                                                                                                                                                If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'ByName'
                                                                                                                                                                                                                                                                                                              • envNameList
                                                                                                                                                                                                                                                                                                                Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
                                                                                                                                                                                                                                                                                                                When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
                                                                                                                                                                                                                                                                                                                If not set, then all environments under the Application will be updated together.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'ByUrl'
                                                                                                                                                                                                                                                                                                              • urlList
                                                                                                                                                                                                                                                                                                                Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
                                                                                                                                                                                                                                                                                                                When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
                                                                                                                                                                                                                                                                                                                If not set, then all environments under the Application will be updated together.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                          • envLookup
                                                                                                                                                                                                                                                                                                              Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                            • $class: 'AWSEBElasticBeanstalkSetup'
                                                                                                                                                                                                                                                                                                            • $class: 'AWSEBS3Setup'
                                                                                                                                                                                                                                                                                                              • bucketName
                                                                                                                                                                                                                                                                                                                S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • bucketRegion
                                                                                                                                                                                                                                                                                                                S3 Bucket Region (e.g. us-east-1) This will be the same region set for the Elastic Beanstalk application if none is specified.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • keyPrefix
                                                                                                                                                                                                                                                                                                                Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • rootObject

                                                                                                                                                                                                                                                                                                                Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.

                                                                                                                                                                                                                                                                                                                It could be either a path to a zip file or a directory.

                                                                                                                                                                                                                                                                                                                If its a directory, includes and excludes are used to build the zip file

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • overwriteExistingFile
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • useTransferAcceleration
                                                                                                                                                                                                                                                                                                                If enabled on the bucket, uses transfer acceleration to upload artifacts quicker. This may incur additional AWS costs.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'ByName'
                                                                                                                                                                                                                                                                                                              • envNameList
                                                                                                                                                                                                                                                                                                                Optional: Newline separated list of AWS EB Environment Names for the Application (e.g.: "myapp-prod-env").
                                                                                                                                                                                                                                                                                                                When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
                                                                                                                                                                                                                                                                                                                If not set, then all environments under the Application will be updated together.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'ByUrl'
                                                                                                                                                                                                                                                                                                              • urlList
                                                                                                                                                                                                                                                                                                                Optional: Newline separated list of AWS EB Environment url, or CNAMEs for the Application (e.g.: "myapp-prod-env.elasticbeanstalk.com").
                                                                                                                                                                                                                                                                                                                When set and Environment Name exists, it will trigger a UpdateEnvironment Call when the Application Version is created.
                                                                                                                                                                                                                                                                                                                If not set, then all environments under the Application will be updated together.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                      • $class: 'AWSEBDeploymentBuilder'
                                                                                                                                                                                                                                                                                                        • config
                                                                                                                                                                                                                                                                                                          • Type: class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
                                                                                                                                                                                                                                                                                                        • applicationName (optional)
                                                                                                                                                                                                                                                                                                          AWS EB Application Name (e.g.: "myapp")
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • awsRegion (optional)
                                                                                                                                                                                                                                                                                                          AWS Region (e.g. us-east-1)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • bucketName (optional)

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

                                                                                                                                                                                                                                                                                                          (Optional, will call createStorageLocation if blank)

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • checkHealth (optional)
                                                                                                                                                                                                                                                                                                          Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • credentialId (optional)
                                                                                                                                                                                                                                                                                                          Select the credentials to use.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • environmentName (optional)

                                                                                                                                                                                                                                                                                                          Optional: AWS EB Environment name(s) to deploy to.

                                                                                                                                                                                                                                                                                                          Can accept single or multiple comma-separated values. Examples:

                                                                                                                                                                                                                                                                                                          • "my-prod-env" (single environment)
                                                                                                                                                                                                                                                                                                          • "my-dev-env,my-staging-env" (multiple environments)

                                                                                                                                                                                                                                                                                                          When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.

                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • excludes (optional)
                                                                                                                                                                                                                                                                                                          Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • includes (optional)
                                                                                                                                                                                                                                                                                                          Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • keyPrefix (optional)
                                                                                                                                                                                                                                                                                                          Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • maxAttempts (optional)
                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                        • rootObject (optional)

                                                                                                                                                                                                                                                                                                          Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against

                                                                                                                                                                                                                                                                                                          Examples:

                                                                                                                                                                                                                                                                                                          • File, like target/mywebapp.war: The war file will be uploaded
                                                                                                                                                                                                                                                                                                          • A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • skipEnvironmentUpdates (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • sleepTime (optional)
                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                        • versionDescriptionFormat (optional)
                                                                                                                                                                                                                                                                                                          How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • versionLabelFormat (optional)
                                                                                                                                                                                                                                                                                                          How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • zeroDowntime (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • awsebReleaser
                                                                                                                                                                                                                                                                                                        • credentialId
                                                                                                                                                                                                                                                                                                          Select the credentials to use.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • awsRegion
                                                                                                                                                                                                                                                                                                          AWS Region.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • applicationName
                                                                                                                                                                                                                                                                                                          AWS EB Application Name (e.g.: "myapp").
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • environmentId
                                                                                                                                                                                                                                                                                                          AWS EB Environment name to deploy to.
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • versionLabel
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                      • abapCi
                                                                                                                                                                                                                                                                                                        • abapPackagename (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • atcVariant (optional)
                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                        • runAtcChecks (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • runUnitTests (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • treatWarningAtcChecksAsErrors (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                        • useJenkinsProjectName (optional)
                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                      • $class: 'ActionHubPlugin'
                                                                                                                                                                                                                                                                                                        • snActivatePlugin
                                                                                                                                                                                                                                                                                                          • credentialsId (optional)
                                                                                                                                                                                                                                                                                                            User name and password defined in global credentials (credentials ID is required here).
                                                                                                                                                                                                                                                                                                            This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • apiVersion (optional)
                                                                                                                                                                                                                                                                                                            Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • pluginId (optional)
                                                                                                                                                                                                                                                                                                            Unique identifier of the plugin. You can locate this identifier on the Plugins page within the card of the desired plugin; identified with the name "ID".
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • url (optional)
                                                                                                                                                                                                                                                                                                            ServiceNow instance url. This field cannot be empty. It doesn't use global settings from ServiceNow Parameters.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • $class: 'AddComment'
                                                                                                                                                                                                                                                                                                          • prefix
                                                                                                                                                                                                                                                                                                            Enter the syntax. Example: P1#I10 (P3 - Project ID, I10 - Item ID). You can only add a comment up to 10 items.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • note
                                                                                                                                                                                                                                                                                                            Any malicious content will be automatically removed.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • logfile
                                                                                                                                                                                                                                                                                                            Upload the build log file as an attachment.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • $class: 'AddTestToSetStep'
                                                                                                                                                                                                                                                                                                          • domain
                                                                                                                                                                                                                                                                                                            HP ALM Domain
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • project
                                                                                                                                                                                                                                                                                                            HP ALM Project name
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • testPlanPath
                                                                                                                                                                                                                                                                                                            Path to a test or test folder in HP ALM which shall be added to a test set
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • testSetPath
                                                                                                                                                                                                                                                                                                            Path to a test set in HP ALM into which test(s) shall be added
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • $class: 'AmxEclipseAntBuilder'
                                                                                                                                                                                                                                                                                                          • targets
                                                                                                                                                                                                                                                                                                            Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • name
                                                                                                                                                                                                                                                                                                            For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

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

                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • antOpts
                                                                                                                                                                                                                                                                                                            If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • buildFile
                                                                                                                                                                                                                                                                                                            If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • properties
                                                                                                                                                                                                                                                                                                            Properties needed by your ant build can be specified here (in standard properties file format):
                                                                                                                                                                                                                                                                                                            # comment
                                                                                                                                                                                                                                                                                                            name1=value1
                                                                                                                                                                                                                                                                                                            name2=$VAR2
                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • amxEclipseAntTra
                                                                                                                                                                                                                                                                                                            If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • businessStudioWs
                                                                                                                                                                                                                                                                                                            If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • anchore
                                                                                                                                                                                                                                                                                                          • name
                                                                                                                                                                                                                                                                                                            Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • annotations (optional)
                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                            • key
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                          • autoSubscribeTagUpdates (optional)
                                                                                                                                                                                                                                                                                                            If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • bailOnFail (optional)
                                                                                                                                                                                                                                                                                                            If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • bailOnPluginFail (optional)
                                                                                                                                                                                                                                                                                                            If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • engineCredentialsId (optional)
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • engineRetries (optional)
                                                                                                                                                                                                                                                                                                            Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • engineurl (optional)
                                                                                                                                                                                                                                                                                                            Anchore Engine URL
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • engineverify (optional)
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • forceAnalyze (optional)
                                                                                                                                                                                                                                                                                                            If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                          • policyBundleId (optional)
                                                                                                                                                                                                                                                                                                            ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                        • $class: 'AnsibleAdHocCommandBuilder'
                                                                                                                                                                                                                                                                                                          • hostPattern
                                                                                                                                                                                                                                                                                                            The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                          • inventory
                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                            • $class: 'InventoryContent'
                                                                                                                                                                                                                                                                                                              • content
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • dynamic
                                                                                                                                                                                                                                                                                                                Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'InventoryDoNotSpecify'
                                                                                                                                                                                                                                                                                                              • $class: 'InventoryPath'
                                                                                                                                                                                                                                                                                                                • path
                                                                                                                                                                                                                                                                                                                  Specify the inventory host path or a comma separated host list
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • module
                                                                                                                                                                                                                                                                                                              Module name to execute. The shell module is used when left empty.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                              Module arguments or shell command to execute
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • additionalParameters (optional)
                                                                                                                                                                                                                                                                                                              Any additional parameters to pass to the ansible command.

                                                                                                                                                                                                                                                                                                              Warning:

                                                                                                                                                                                                                                                                                                              The content of this textbox will be passed as is to the command line.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • ansibleName (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • becomeUser (optional)
                                                                                                                                                                                                                                                                                                              Desired become user. "root" is used when this field is empty.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • colorizedOutput (optional)
                                                                                                                                                                                                                                                                                                              Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • credentialsId (optional)
                                                                                                                                                                                                                                                                                                              Select the credentials for the SSH connections. Only private key authentication is supported.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • disableHostKeyChecking (optional)
                                                                                                                                                                                                                                                                                                              Check this box if you really want to disable the validation of the hosts SSH server keys.
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • extraVars (optional)
                                                                                                                                                                                                                                                                                                                Array / List of Nested Object
                                                                                                                                                                                                                                                                                                              • hidden (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • key (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • value (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • forks (optional)
                                                                                                                                                                                                                                                                                                              Specify number of parallel processes to use. Set to 0 to use the default value.
                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                            • hostKeyChecking (optional)
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • sudo (optional)
                                                                                                                                                                                                                                                                                                              Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • sudoUser (optional)
                                                                                                                                                                                                                                                                                                              Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • unbufferedOutput (optional)
                                                                                                                                                                                                                                                                                                              Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • vaultCredentialsId (optional)
                                                                                                                                                                                                                                                                                                              Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                          • cfyAnsible
                                                                                                                                                                                                                                                                                                            • additionalArgs (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • ansibleEnvVars (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • credentialsId (optional)

                                                                                                                                                                                                                                                                                                              The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • debugLevel (optional)
                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                            • debugOutput (optional)
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • deploymentId (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • echoEnvData (optional)
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • echoInputs (optional)
                                                                                                                                                                                                                                                                                                              If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • envDataLocation (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • optionsConfig (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • playbookPath (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • remergeSources (optional)
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • runData (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • savePlaybook (optional)
                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                            • scpExtraArgs (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sensitiveKeys (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sftpExtraArgs (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sourcePath (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sources (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sshCommonArgs (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • sshExtraArgs (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • startAtTask (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • tenant (optional)
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • timeout (optional)
                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                          • $class: 'AnsiblePlaybookBuilder'
                                                                                                                                                                                                                                                                                                            • playbook
                                                                                                                                                                                                                                                                                                              Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                            • inventory
                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                              • $class: 'InventoryContent'
                                                                                                                                                                                                                                                                                                                • content
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • dynamic
                                                                                                                                                                                                                                                                                                                  Check this box if a dynamic inventory is used. For more details see the ansible documentation for Dynamic Inventory
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                              • $class: 'InventoryDoNotSpecify'
                                                                                                                                                                                                                                                                                                                • $class: 'InventoryPath'
                                                                                                                                                                                                                                                                                                                  • path
                                                                                                                                                                                                                                                                                                                    Specify the inventory host path or a comma separated host list
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                              • additionalParameters (optional)
                                                                                                                                                                                                                                                                                                                Any additional parameters to pass to the ansible command.

                                                                                                                                                                                                                                                                                                                Warning:

                                                                                                                                                                                                                                                                                                                The content of this textbox will be passed as is to the command line.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • ansibleName (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • becomeUser (optional)
                                                                                                                                                                                                                                                                                                                Desired become user. "root" is used when this field is empty.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • colorizedOutput (optional)
                                                                                                                                                                                                                                                                                                                Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                Select the credentials for the SSH connections. Only private key authentication is supported.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • disableHostKeyChecking (optional)
                                                                                                                                                                                                                                                                                                                Check this box if you really want to disable the validation of the hosts SSH server keys.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • extraVars (optional)
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • hidden (optional)
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • key (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • value (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • forks (optional)
                                                                                                                                                                                                                                                                                                                Specify number of parallel processes to use. Set to 0 to use the default value.
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • hostKeyChecking (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • limit (optional)
                                                                                                                                                                                                                                                                                                                Further limit selected hosts to an additional pattern.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • skippedTags (optional)
                                                                                                                                                                                                                                                                                                                only run plays and tasks whose tags do not match these values.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • startAtTask (optional)
                                                                                                                                                                                                                                                                                                                Start the playbook at the task matching this name.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • sudo (optional)
                                                                                                                                                                                                                                                                                                                Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • sudoUser (optional)
                                                                                                                                                                                                                                                                                                                Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • tags (optional)
                                                                                                                                                                                                                                                                                                                Only run plays and tasks tagged with these values.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • unbufferedOutput (optional)
                                                                                                                                                                                                                                                                                                                Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • vaultCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AnsibleTower'
                                                                                                                                                                                                                                                                                                              • towerServer (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobTemplate (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • towerCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobType (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • extraVars (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobTags (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • skipJobTags (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • limit (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • inventory (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • credential (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • scmBranch (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • verbose (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • importTowerLogs (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • removeColor (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • templateType (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • importWorkflowChildLogs (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'AnsibleTowerProjectRevisionFreestyle'
                                                                                                                                                                                                                                                                                                              • towerServer (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • towerCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • project (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • revision (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • verbose (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • throwExceptionWhenFail (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'AnsibleTowerProjectSyncFreestyle'
                                                                                                                                                                                                                                                                                                              • towerServer (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • towerCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • project (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • verbose (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • importTowerLogs (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • removeColor (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'AnsibleVaultBuilder'
                                                                                                                                                                                                                                                                                                              • action (optional)
                                                                                                                                                                                                                                                                                                                Desired vault action.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • ansibleName (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • content (optional)
                                                                                                                                                                                                                                                                                                                Desired encrypted content.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • input (optional)
                                                                                                                                                                                                                                                                                                                Desired input file to encrypt.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • newVaultCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • output (optional)
                                                                                                                                                                                                                                                                                                                Desired output file for encrypted content.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • vaultCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • ant
                                                                                                                                                                                                                                                                                                              For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

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

                                                                                                                                                                                                                                                                                                              • targets
                                                                                                                                                                                                                                                                                                                Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antOpts
                                                                                                                                                                                                                                                                                                                If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • buildFile
                                                                                                                                                                                                                                                                                                                If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • properties
                                                                                                                                                                                                                                                                                                                Properties needed by your ant build can be specified here (in standard properties file format):
                                                                                                                                                                                                                                                                                                                # comment
                                                                                                                                                                                                                                                                                                                name1=value1
                                                                                                                                                                                                                                                                                                                name2=$VAR2
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AntExec'
                                                                                                                                                                                                                                                                                                              • scriptSource
                                                                                                                                                                                                                                                                                                                Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.

                                                                                                                                                                                                                                                                                                                The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • extendedScriptSource
                                                                                                                                                                                                                                                                                                                Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • scriptName
                                                                                                                                                                                                                                                                                                                Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • properties
                                                                                                                                                                                                                                                                                                                Properties needed by your ant build can be specified here (in standard properties file format):
                                                                                                                                                                                                                                                                                                                # comment
                                                                                                                                                                                                                                                                                                                name1=value1
                                                                                                                                                                                                                                                                                                                name2=$VAR2
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antOpts
                                                                                                                                                                                                                                                                                                                If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
                                                                                                                                                                                                                                                                                                                Note that other Ant options (such as -lib) should not be here.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • keepBuildfile
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • verbose
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • emacs
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • noAntcontrib

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

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

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

                                                                                                                                                                                                                                                                                                              • targets
                                                                                                                                                                                                                                                                                                                Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • antOpts
                                                                                                                                                                                                                                                                                                                If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • buildFile
                                                                                                                                                                                                                                                                                                                If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • properties
                                                                                                                                                                                                                                                                                                                Properties needed by your ant build can be specified here (in standard properties file format):
                                                                                                                                                                                                                                                                                                                # comment
                                                                                                                                                                                                                                                                                                                name1=value1
                                                                                                                                                                                                                                                                                                                name2=$VAR2
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'ApiFortressBuilder'
                                                                                                                                                                                                                                                                                                              • mode
                                                                                                                                                                                                                                                                                                                When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • hook
                                                                                                                                                                                                                                                                                                                The API Hook URL.
                                                                                                                                                                                                                                                                                                                API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
                                                                                                                                                                                                                                                                                                                You can create one in the API Fortress Company dashboard.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • id

                                                                                                                                                                                                                                                                                                                Test ID

                                                                                                                                                                                                                                                                                                                When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.

                                                                                                                                                                                                                                                                                                                Automatch URL

                                                                                                                                                                                                                                                                                                                When running in Automatch mode, introduce here the URL of the resource that you are willing to test.

                                                                                                                                                                                                                                                                                                                Tag

                                                                                                                                                                                                                                                                                                                When running in tag mode, introduce the tag of the tests you want to run.

                                                                                                                                                                                                                                                                                                                Project

                                                                                                                                                                                                                                                                                                                When running in project mode, no value is required.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • blocking
                                                                                                                                                                                                                                                                                                                Set this flag is a test failure must determine a build failure.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • dryrun
                                                                                                                                                                                                                                                                                                                Set this flag if you don't want the event to be stored in API Fortress.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • silent
                                                                                                                                                                                                                                                                                                                Set this flag if a failure should not generate API Fortress alerts.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • param1name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • param1value
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • param2name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • param2value
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • param3name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • param3value
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • appray
                                                                                                                                                                                                                                                                                                              • appRayUrl
                                                                                                                                                                                                                                                                                                                App-Ray instance URL. Default: https://demo.app-ray.co
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • outputFilePath
                                                                                                                                                                                                                                                                                                                Name of the binary file (apk, ipa) to be scanned relative to the workspace. You can use Jenkins variables to specify the filename.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • waitTimeout
                                                                                                                                                                                                                                                                                                                Timeout of waiting for ending of a scan. (For big application sometimes it take more than 30 minute!)
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • riskScoreThreshold
                                                                                                                                                                                                                                                                                                                The minimum risk score to check the apk validity. It is the output of then scan. You can check the scores on the app-ray instance.
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • credentialsId
                                                                                                                                                                                                                                                                                                                Use email address as a username and please provide a password. The user must have full-access access right in App-Ray in order to be able to submit applications for scanning.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • appscan
                                                                                                                                                                                                                                                                                                              • scanner
                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                • dynamic_analyzer
                                                                                                                                                                                                                                                                                                                  • target
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • hasOptions
                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                  • extraField (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • loginPassword (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • loginUser (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • optimization (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • presenceId (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • scanFile (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • scanType (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • testPolicy (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                • mobile_analyzer
                                                                                                                                                                                                                                                                                                                  • target
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • hasOptions
                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                  • extraField (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • loginPassword (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • loginUser (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • presenceId (optional)
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                • static_analyzer
                                                                                                                                                                                                                                                                                                                  • target
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • hasOptions
                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                  • openSourceOnly (optional)
                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                              • name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • type
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • application
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • credentials
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • email (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • failBuild (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • failBuildNonCompliance (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • failureConditions (optional)
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • failureType
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • threshold
                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                              • target (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • wait (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • appscanenterprise
                                                                                                                                                                                                                                                                                                              • credentials
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • folder
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • testPolicy
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • template
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • accessId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • agent (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • application (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • email (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • exploreData (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • failBuild (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • failureConditions (optional)
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • failureType
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • threshold
                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                              • loginType (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • scanType (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • secretKey (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • target (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • testOptimization (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • trafficFile (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • wait (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'AppScanSourceBuilder'
                                                                                                                                                                                                                                                                                                              • disableScan
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • applicationFile
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • acceptSSL
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • customScanWorkspace

                                                                                                                                                                                                                                                                                                                This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.

                                                                                                                                                                                                                                                                                                                If this field is blank, the default scan directory will be used.

                                                                                                                                                                                                                                                                                                                The default directory is this job's build folder, as defined by Jenkins.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • installation (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AppScanStandardBuilder'
                                                                                                                                                                                                                                                                                                              • startingURL
                                                                                                                                                                                                                                                                                                                Insert the URL that you want AppScan Standard to start scanning from.

                                                                                                                                                                                                                                                                                                                Spiders will find the remaining URLs in the domain to be included for scanning.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • installation
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • additionalCommands (optional)
                                                                                                                                                                                                                                                                                                                Provide additional and optional commands to run on AppScan Standard CLI.
                                                                                                                                                                                                                                                                                                                AppScanCMD exec|ex|e
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Parameters:
                                                                                                                                                                                                                                                                                                                        [ /dest_scan|/dest|/d  ]
                                                                                                                                                                                                                                                                                                                        [ /base_scan|/base|/b  ]
                                                                                                                                                                                                                                                                                                                        [ /old_host|/ohost|/oh  ]
                                                                                                                                                                                                                                                                                                                        [ /new_host|/nhost|/nh  ]
                                                                                                                                                                                                                                                                                                                        [ /scan_template|/stemplate|/st  ]
                                                                                                                                                                                                                                                                                                                        [ /login_file|/lfile|/lf  ]
                                                                                                                                                                                                                                                                                                                        [ /multi_step_file|/mstepfile|/mf  ]
                                                                                                                                                                                                                                                                                                                        [ /manual_explore_file|/mexplorefile|/mef  ]
                                                                                                                                                                                                                                                                                                                        [ /policy_file|/pfile|/pf  ]
                                                                                                                                                                                                                                                                                                                        [ /additional_domains|/adomains|/ad  ]
                                                                                                                                                                                                                                                                                                                        [ /report_file|/rf  ]
                                                                                                                                                                                                                                                                                                                        [ /report_type|/rt  {xml} ]
                                                                                                                                                                                                                                                                                                                        [ /min_severity|/msev  {informational} ]
                                                                                                                                                                                                                                                                                                                        [ /test_type|/tt  ]
                                                                                                                                                                                                                                                                                                                        [ /report_template|/rtemplate|/rtm  {CliDefault} ]
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Flags:
                                                                                                                                                                                                                                                                                                                        [ /verbose|/v {false} ]
                                                                                                                                                                                                                                                                                                                        [ /scan_log|/sl {false} ]
                                                                                                                                                                                                                                                                                                                        [ /explore_only|/eo {false} ]
                                                                                                                                                                                                                                                                                                                        [ /test_only|/to {false} ]
                                                                                                                                                                                                                                                                                                                        [ /multi_step|/mstep|/ms {false} ]
                                                                                                                                                                                                                                                                                                                        [ /continue|/c {false} ]
                                                                                                                                                                                                                                                                                                                        [ /merge_manual_explore_requests|/mmer {false} ]
                                                                                                                                                                                                                                                                                                                        [ /include_responses|/ir {false} ]
                                                                                                                                                                                                                                                                                                                        [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp  ]
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Creates new scan with base_scan's configuration
                                                                                                                                                                                                                                                                                                                    saving dest_scan and creating report, if configured.
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                AppScanCMD report|rep|r
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Parametrs:
                                                                                                                                                                                                                                                                                                                        /base_scan|/base|/b
                                                                                                                                                                                                                                                                                                                        /report_file|/rf
                                                                                                                                                                                                                                                                                                                        /report_type|/rt
                                                                                                                                                                                                                                                                                                                        [ /min_severity|/msev  {informational} ]
                                                                                                                                                                                                                                                                                                                        [ /test_type|/tt  ]
                                                                                                                                                                                                                                                                                                                        [ /report_template|/rtemplate|/rtm  {CliDefault} ]
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Flags:
                                                                                                                                                                                                                                                                                                                        [ /verbose|/v {false} ]
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Creates a report for base_scan.
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                AppScanCMD close_proxy|cprxy|cpr
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                        Closes AppScan proxy if was previously opened.
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                More info. at:
                                                                                                                                                                                                                                                                                                                (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
                                                                                                                                                                                                                                                                                                                http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • authScan (optional)
                                                                                                                                                                                                                                                                                                                Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.

                                                                                                                                                                                                                                                                                                                If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • authScanPw (optional)
                                                                                                                                                                                                                                                                                                                Provide the password corresponding to the account's user name inserted above.

                                                                                                                                                                                                                                                                                                                Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • authScanRadio (optional)
                                                                                                                                                                                                                                                                                                                Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.

                                                                                                                                                                                                                                                                                                                A login sequence may be recorded using AppScan Standard's GUI by following these steps:

                                                                                                                                                                                                                                                                                                                "Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).

                                                                                                                                                                                                                                                                                                                Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • authScanUser (optional)
                                                                                                                                                                                                                                                                                                                Provide the user name of an account with access to the private functionalities of the website.

                                                                                                                                                                                                                                                                                                                Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • generateReport (optional)
                                                                                                                                                                                                                                                                                                                Check this option if you want AppScan Standard to generate a report after scannning.

                                                                                                                                                                                                                                                                                                                The report is available in HTML and PDF.

                                                                                                                                                                                                                                                                                                                The HTML report generated is ready to be integrated with the HTML Publisher Plugin.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • htmlReport (optional)
                                                                                                                                                                                                                                                                                                                This report can be integrated with the HTML Publisher Plugin.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • includeURLS (optional)
                                                                                                                                                                                                                                                                                                                This is used to include URLs for scanning,

                                                                                                                                                                                                                                                                                                                Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • pathRecordedLoginSequence (optional)
                                                                                                                                                                                                                                                                                                                Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • pdfReport (optional)
                                                                                                                                                                                                                                                                                                                A PDF report is generated.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • policyFile (optional)
                                                                                                                                                                                                                                                                                                                Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.

                                                                                                                                                                                                                                                                                                                A Test Policy File can be created following these steps:

                                                                                                                                                                                                                                                                                                                "Scan" > "Scan Configuration" > "Test Policy" > "Export".

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • reportName (optional)
                                                                                                                                                                                                                                                                                                                Provide the name to save the report with.

                                                                                                                                                                                                                                                                                                                To configure HTML Publisher Plugin properly, the names in the configuration must match.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • verbose (optional)
                                                                                                                                                                                                                                                                                                                Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • xooa
                                                                                                                                                                                                                                                                                                              • name
                                                                                                                                                                                                                                                                                                                Xooa Jenkins
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • appId
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AppUploaderBuilder'
                                                                                                                                                                                                                                                                                                              • buildFilePath
                                                                                                                                                                                                                                                                                                                Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
                                                                                                                                                                                                                                                                                                                The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • applatix
                                                                                                                                                                                                                                                                                                              • axUrl
                                                                                                                                                                                                                                                                                                                The URL of Applatix system. For example: https://applatix.yourcompany.com
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axUsername
                                                                                                                                                                                                                                                                                                                Applatix credential: username
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axPassword
                                                                                                                                                                                                                                                                                                                Applatix credential: password
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axServiceTemplateName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axServiceTemplateRepository
                                                                                                                                                                                                                                                                                                                The repository where your Service Template is.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axServiceTemplateBranch
                                                                                                                                                                                                                                                                                                                The branch where your Service Template is.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • axServiceTemplateParameters
                                                                                                                                                                                                                                                                                                                The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • key
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • snApplyChanges
                                                                                                                                                                                                                                                                                                              • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                User name and password defined in global credentials (credentials ID is required here) used for the instance (usually where the application will be published).
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • apiVersion (optional)
                                                                                                                                                                                                                                                                                                                Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • appScope (optional)
                                                                                                                                                                                                                                                                                                                Required if 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.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • appSysId (optional)
                                                                                                                                                                                                                                                                                                                Required if 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.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • branchName (optional)
                                                                                                                                                                                                                                                                                                                Name of the branch in the source control system from which to acquire the application.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • url (optional)
                                                                                                                                                                                                                                                                                                                ServiceNow instance url (usually where the application will be published to).
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'ApprendaBuilder'
                                                                                                                                                                                                                                                                                                              • appAlias
                                                                                                                                                                                                                                                                                                                The Applicaton Alias to be used.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • appName
                                                                                                                                                                                                                                                                                                                The Applicaton Name to be used.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • versionAlias
                                                                                                                                                                                                                                                                                                                The application Version Alias to target.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • stage
                                                                                                                                                                                                                                                                                                                The desired Apprenda Application lifecycle Stage.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • artifactName
                                                                                                                                                                                                                                                                                                                The filename of the Apprenda Application Package. For example myapplication.zip.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • credentialsId
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • prefix
                                                                                                                                                                                                                                                                                                                The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • advVersionAliasToBeForced
                                                                                                                                                                                                                                                                                                                The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • advancedNewVersionOption
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • customPackageDirectory
                                                                                                                                                                                                                                                                                                                The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • applicationPackageURL
                                                                                                                                                                                                                                                                                                                The complete URL to the Apprenda Application Package, starting with http:// or https://.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • archiveUploadMethod
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • buildWithParameters
                                                                                                                                                                                                                                                                                                                Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • aqua
                                                                                                                                                                                                                                                                                                              • locationType
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • registry
                                                                                                                                                                                                                                                                                                                Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • register
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • localImage
                                                                                                                                                                                                                                                                                                                Path of local Docker image, including tag. E.g. my_ubuntu:latest
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • hostedImage
                                                                                                                                                                                                                                                                                                                Path of Docker image on registry, including tag. E.g. google/mysql:latest
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • onDisallowed
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • notCompliesCmd
                                                                                                                                                                                                                                                                                                                A shell command to execute when image does not comply with Aqua security policy
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • hideBase
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • showNegligible
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • policies
                                                                                                                                                                                                                                                                                                                Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • customFlags
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • tarFilePath (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • aquaMicroscanner
                                                                                                                                                                                                                                                                                                              • imageName
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • onDisallowed
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • notCompliesCmd
                                                                                                                                                                                                                                                                                                                A shell command to execute when image does not comply with Aqua security policy
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • outputFormat
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • aquaServerlessScanner
                                                                                                                                                                                                                                                                                                              • onDisallowed
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • notCompliesCmd
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • codeScanPath
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • customFlags
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • arachniScanner
                                                                                                                                                                                                                                                                                                              • url
                                                                                                                                                                                                                                                                                                                URL of the system under scan.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • checks
                                                                                                                                                                                                                                                                                                                Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • scope
                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                • pageLimit
                                                                                                                                                                                                                                                                                                                  Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                • excludePathPattern
                                                                                                                                                                                                                                                                                                                  Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • userConfig
                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                • filename
                                                                                                                                                                                                                                                                                                                  Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • format
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: '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.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • basedir

                                                                                                                                                                                                                                                                                                                By default, the basedir is the job workspace.
                                                                                                                                                                                                                                                                                                                Give a value to override the default value.

                                                                                                                                                                                                                                                                                                                Path relative to workspace is permitted.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • excludes

                                                                                                                                                                                                                                                                                                                Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • remote

                                                                                                                                                                                                                                                                                                                Artifacts will be deployed in the specified output directory.
                                                                                                                                                                                                                                                                                                                The remote location must be accessible through the build machine (master/slave node).
                                                                                                                                                                                                                                                                                                                If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
                                                                                                                                                                                                                                                                                                                Make sure the Jenkins process have the right permissions to write to the remote location.
                                                                                                                                                                                                                                                                                                                For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • flatten

                                                                                                                                                                                                                                                                                                                Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • deleteRemote

                                                                                                                                                                                                                                                                                                                Delete the output directory before deploying artifacts.

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

                                                                                                                                                                                                                                                                                                                'Skip deletion' option preserves the files in the staging repository.

                                                                                                                                                                                                                                                                                                                Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • artifactResolver
                                                                                                                                                                                                                                                                                                              Resolves artifacts against one or more remote maven repositories.
                                                                                                                                                                                                                                                                                                              • artifacts
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • groupId
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • artifactId
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • version
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • classifier (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • deployToLocal (optional)
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • deployToRemote (optional)
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • extension (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • failOnError (optional)
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • pomFile (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • targetFileName (optional)
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • enableRepositoryLogging (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • enableTransferLogging (optional)
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • repositoryId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • targetDirectory (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • assertthatBddFeatures
                                                                                                                                                                                                                                                                                                              • projectId
                                                                                                                                                                                                                                                                                                                Jira project id.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • credentialsId
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • outputFolder

                                                                                                                                                                                                                                                                                                                Output folder for feature files withing workspace. Default ./features/.
                                                                                                                                                                                                                                                                                                                By default features are downloaded to the root of the workspace.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jql
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • tags
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • mode
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • proxyURI
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • proxyUsername
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • proxyPassword
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jiraServerUrl
                                                                                                                                                                                                                                                                                                                Jira Server URL. Populate only if using Jira Server version (e.g. https://mycompanyjira.com). Leave blank for cloud.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AssetBuilder'
                                                                                                                                                                                                                                                                                                              • name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • description
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • version
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • vendor
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • platform
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • architecture
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • bits
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • cpu
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • memory
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • storage
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • installationScriptFilePath
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • mediaFilePaths
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • path
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                              • licenseFilePath
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • documentationFilePath
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AssociateItemToRelease'
                                                                                                                                                                                                                                                                                                              • releasePrefix
                                                                                                                                                                                                                                                                                                                Enter the release details. Example: P2#R10
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • itemPrefix
                                                                                                                                                                                                                                                                                                                Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • associateTag
                                                                                                                                                                                                                                                                                                              • nexusInstanceId
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • tagName
                                                                                                                                                                                                                                                                                                                The tag which will be applied to components matching the specified search criteria
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • search
                                                                                                                                                                                                                                                                                                                The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • key
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AstreeBuilder'
                                                                                                                                                                                                                                                                                                              • dax_file
                                                                                                                                                                                                                                                                                                                Absolute path to the DAX file containing the analysis specification and configuration.
                                                                                                                                                                                                                                                                                                                Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
                                                                                                                                                                                                                                                                                                                Paths and environment variables are evaluated on the machine running Jenkins.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • analysis_id
                                                                                                                                                                                                                                                                                                                ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
                                                                                                                                                                                                                                                                                                                Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • output_dir
                                                                                                                                                                                                                                                                                                                Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
                                                                                                                                                                                                                                                                                                                Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • skip_analysis
                                                                                                                                                                                                                                                                                                                This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLOverview
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLCoverage
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLAlarmsByOccurence
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLAlarmsByCategory
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLAlarmsByFile
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genXMLRulechecks
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • dropAnalysis
                                                                                                                                                                                                                                                                                                                When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
                                                                                                                                                                                                                                                                                                                This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
                                                                                                                                                                                                                                                                                                                Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
                                                                                                                                                                                                                                                                                                                This option corresponds to adding a --drop to a command line call to Astrée.
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • genPreprocessOutput
                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                              • failonswitch
                                                                                                                                                                                                                                                                                                                This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
                                                                                                                                                                                                                                                                                                                • Only Errors
                                                                                                                                                                                                                                                                                                                  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
                                                                                                                                                                                                                                                                                                                  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
                                                                                                                                                                                                                                                                                                                • Errors and Alarms
                                                                                                                                                                                                                                                                                                                  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
                                                                                                                                                                                                                                                                                                                  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
                                                                                                                                                                                                                                                                                                                • Errors, Alarms, and Data-Flow Anomalies
                                                                                                                                                                                                                                                                                                                  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
                                                                                                                                                                                                                                                                                                                  This setting fails builds on any reported potential code defect or anomaly.
                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                • failon
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • audit
                                                                                                                                                                                                                                                                                                              • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • minScore (optional)
                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                              • collectionName (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • platformUrl (optional)
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AutEnvironmentBuilder'
                                                                                                                                                                                                                                                                                                              • autEnvironmentModel
                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                • almServerName
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • almUserName
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • almPassword
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • almDomain
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • almProject
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • clientType
                                                                                                                                                                                                                                                                                                                  Client type should be provided if your server is ALM version 12.60 or above.
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • autEnvironmentId
                                                                                                                                                                                                                                                                                                                  Assign ID of an AUT Environment that exists in the ALM project you selected.
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • useExistingAutEnvConf
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • existingAutEnvConfId
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • createNewAutEnvConf
                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                • newAutEnvConfName
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • autEnvironmentParameters
                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                  • name
                                                                                                                                                                                                                                                                                                                    The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)

                                                                                                                                                                                                                                                                                                                    For example: 'Parameters/DB_Setting/Oracle/username'
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • value
                                                                                                                                                                                                                                                                                                                    If you are using a 'From JSON' type, specify here the path for the element you would like to get.

                                                                                                                                                                                                                                                                                                                    Make sure you are using JsonPath style for defining it.
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • paramType
                                                                                                                                                                                                                                                                                                                    Manual - the value you'll assign for 'Parameter value' field will be used as is.

                                                                                                                                                                                                                                                                                                                    Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).

                                                                                                                                                                                                                                                                                                                    From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • shouldGetOnlyFirstValueFromJson
                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                • pathToJsonFile
                                                                                                                                                                                                                                                                                                                  A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • outputParameter
                                                                                                                                                                                                                                                                                                                  The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.

                                                                                                                                                                                                                                                                                                                  The parameter must be a String Parameter.

                                                                                                                                                                                                                                                                                                                  If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • $class: 'AutoConfigBuilder'
                                                                                                                                                                                                                                                                                                              • name
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • discobitUrl
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • discobitUser
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • discobitPassword
                                                                                                                                                                                                                                                                                                                • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                              • configurations
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • cuuid
                                                                                                                                                                                                                                                                                                                • Type: 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.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • environment

                                                                                                                                                                                                                                                                                                                Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • system

                                                                                                                                                                                                                                                                                                                Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • subsystem

                                                                                                                                                                                                                                                                                                                Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • stage

                                                                                                                                                                                                                                                                                                                Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • instance

                                                                                                                                                                                                                                                                                                                Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.

                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • signout

                                                                                                                                                                                                                                                                                                                Select this option to work with elements in CA Endevor® that might be currently worked on by another user.

                                                                                                                                                                                                                                                                                                                Select the Override signout option only if you have the permission to override the signout of another user.

                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                            • $class: 'AwsBatchBuilder'
                                                                                                                                                                                                                                                                                                              • jobname
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobdefinition
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • command
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • jobqueue
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • vcpu
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • memory
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • retries
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                            • azureCLI
                                                                                                                                                                                                                                                                                                              • principalCredentialId
                                                                                                                                                                                                                                                                                                                The Service Principal credentials required to connect to your Azure account.
                                                                                                                                                                                                                                                                                                                More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
                                                                                                                                                                                                                                                                                                                If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
                                                                                                                                                                                                                                                                                                                If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • commands
                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                • script
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                • exportVariablesString
                                                                                                                                                                                                                                                                                                                  Export the output of the command to environment variables
                                                                                                                                                                                                                                                                                                                  The format: /"variable from JSON" | "desired environment variable name"
                                                                                                                                                                                                                                                                                                                  For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                            • azureDownload
                                                                                                                                                                                                                                                                                                              • storageCredentialId
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • downloadType
                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                              • buildSelector (optional)
                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                • downstream
                                                                                                                                                                                                                                                                                                                  • upstreamProjectName

                                                                                                                                                                                                                                                                                                                    Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

                                                                                                                                                                                                                                                                                                                    Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

                                                                                                                                                                                                                                                                                                                    Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

                                                                                                                                                                                                                                                                                                                    AbstractProject based projects:
                                                                                                                                                                                                                                                                                                                    Freestyle projects
                                                                                                                                                                                                                                                                                                                    Multi-configuration projects
                                                                                                                                                                                                                                                                                                                    Maven projects
                                                                                                                                                                                                                                                                                                                    Non AbstractProject based projects:
                                                                                                                                                                                                                                                                                                                    Pipeline jobs (aka. Workflow jobs)

                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                  • upstreamBuildNumber
                                                                                                                                                                                                                                                                                                                    The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                • lastWithArtifacts
                                                                                                                                                                                                                                                                                                                  • lastCompleted
                                                                                                                                                                                                                                                                                                                    • $class: 'MultiJobBuildSelector'
                                                                                                                                                                                                                                                                                                                      • buildParameter
                                                                                                                                                                                                                                                                                                                        • parameterName
                                                                                                                                                                                                                                                                                                                          Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

                                                                                                                                                                                                                                                                                                                          You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                      • permalink
                                                                                                                                                                                                                                                                                                                        • id
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                      • $class: 'PromotedBuildSelector'
                                                                                                                                                                                                                                                                                                                        • level
                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                      • latestSavedBuild
                                                                                                                                                                                                                                                                                                                        • specific
                                                                                                                                                                                                                                                                                                                          • buildNumber
                                                                                                                                                                                                                                                                                                                            While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                        • lastSuccessful
                                                                                                                                                                                                                                                                                                                          • stable (optional)
                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                        • upstream
                                                                                                                                                                                                                                                                                                                          • allowUpstreamDependencies (optional)
                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • fallbackToLastSuccessful (optional)
                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • upstreamFilterStrategy (optional)
                                                                                                                                                                                                                                                                                                                            Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
                                                                                                                                                                                                                                                                                                                            • Values: UseGlobalSetting, UseOldest, UseNewest
                                                                                                                                                                                                                                                                                                                        • workspace
                                                                                                                                                                                                                                                                                                                        • containerName (optional)
                                                                                                                                                                                                                                                                                                                          Enter a storage container name.
                                                                                                                                                                                                                                                                                                                          Environment variables can also be referenced.
                                                                                                                                                                                                                                                                                                                          For example: ${JOB_NAME}
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • deleteFromAzureAfterDownload (optional)
                                                                                                                                                                                                                                                                                                                          If checked, the file copy on Azure will be removed after it's downloaded to local.
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • downloadDirLoc (optional)
                                                                                                                                                                                                                                                                                                                          Enter a download path. If not specified, the files will be downloaded into the job's workspace.
                                                                                                                                                                                                                                                                                                                          Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • excludeFilesPattern (optional)
                                                                                                                                                                                                                                                                                                                          Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
                                                                                                                                                                                                                                                                                                                          For example: ${JOB_NAME}
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • fileShare (optional)
                                                                                                                                                                                                                                                                                                                          Enter a Azure File Storage Share name.
                                                                                                                                                                                                                                                                                                                          Environment variables can also be referenced.
                                                                                                                                                                                                                                                                                                                          For example: ${JOB_NAME}
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • flattenDirectories (optional)
                                                                                                                                                                                                                                                                                                                          If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • includeArchiveZips (optional)
                                                                                                                                                                                                                                                                                                                          The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • includeFilesPattern (optional)
                                                                                                                                                                                                                                                                                                                          Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
                                                                                                                                                                                                                                                                                                                          For example: ${JOB_NAME}
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • projectName (optional)
                                                                                                                                                                                                                                                                                                                          The name of the project to download the managed artifact from.
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • verbose (optional)

                                                                                                                                                                                                                                                                                                                          Enabling this will provide more logging on downloading files.

                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                      • $class: 'BDSBuilder'
                                                                                                                                                                                                                                                                                                                        • projectFile
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • switches
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • installationName
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                      • $class: 'BapFtpBuilder'
                                                                                                                                                                                                                                                                                                                        Send files over FTP as a build step during the build.
                                                                                                                                                                                                                                                                                                                        • publishers
                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                          • configName

                                                                                                                                                                                                                                                                                                                            Select an FTP configuration from the list configured in the global configuration of this Jenkins.

                                                                                                                                                                                                                                                                                                                            The configuration defines the connection properties and base directory of the FTP server.

                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                          • verbose
                                                                                                                                                                                                                                                                                                                            Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • transfers
                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                            • sourceFiles

                                                                                                                                                                                                                                                                                                                              Files to upload to a server.

                                                                                                                                                                                                                                                                                                                              The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
                                                                                                                                                                                                                                                                                                                              The base directory for this fileset is the workspace.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • excludes

                                                                                                                                                                                                                                                                                                                              Exclude files from the Transfer set.

                                                                                                                                                                                                                                                                                                                              The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • remoteDirectory

                                                                                                                                                                                                                                                                                                                              Optional destination folder.

                                                                                                                                                                                                                                                                                                                              This folder will be below the one in the global configuration, if present.
                                                                                                                                                                                                                                                                                                                              The folder will be created if does not exist.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • removePrefix

                                                                                                                                                                                                                                                                                                                              First part of the file path that should not be created on the remote server.

                                                                                                                                                                                                                                                                                                                              Directory structures are created relative to the base directory, which is usually the workspace.
                                                                                                                                                                                                                                                                                                                              You normally do not want the full path to these files to be created on the server.
                                                                                                                                                                                                                                                                                                                              For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
                                                                                                                                                                                                                                                                                                                              Jenkins environment variables can be used in this path.

                                                                                                                                                                                                                                                                                                                              If you use remove prefix, then ALL source file paths MUST start with the prefix.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • asciiMode

                                                                                                                                                                                                                                                                                                                              Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.

                                                                                                                                                                                                                                                                                                                              Use with ASCII text files to fix the line terminators when transferring between different operating systems.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • remoteDirectorySDF

                                                                                                                                                                                                                                                                                                                              Select this to include the timestamp in the remote directory.

                                                                                                                                                                                                                                                                                                                              The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
                                                                                                                                                                                                                                                                                                                              This setting turns the remote directory option into a java SimpleDateFormat.
                                                                                                                                                                                                                                                                                                                              The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
                                                                                                                                                                                                                                                                                                                              As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.

                                                                                                                                                                                                                                                                                                                              Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

                                                                                                                                                                                                                                                                                                                              Remote directory Directories created
                                                                                                                                                                                                                                                                                                                              'qa-approved/'yyyyMMddHHmmss qa-approved/20101107154555
                                                                                                                                                                                                                                                                                                                              'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' builds/2010/11/07/build-456 (if the build was number 456)
                                                                                                                                                                                                                                                                                                                              yyyy_MM/'build'-EEE-d-HHmmss 2010_11/build-Sun-7-154555
                                                                                                                                                                                                                                                                                                                              yyyy-MM-dd_HH-mm-ss 2010-11-07_15-45-55

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • flatten

                                                                                                                                                                                                                                                                                                                              Only create files on the server, don't create directories (except for the remote directory, if present).

                                                                                                                                                                                                                                                                                                                              All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • cleanRemote

                                                                                                                                                                                                                                                                                                                              Select to delete all files and directories within the remote directory before transferring files.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • noDefaultExcludes
                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • makeEmptyDirs

                                                                                                                                                                                                                                                                                                                              The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
                                                                                                                                                                                                                                                                                                                              Selecting this option will create any directories that match the Source files pattern, even if empty.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • patternSeparator

                                                                                                                                                                                                                                                                                                                              The regular expression that is used to separate the Source files and Exclude files patterns.

                                                                                                                                                                                                                                                                                                                              The Source files and Exclude files both accept multiple patterns that by default are split using

                                                                                                                                                                                                                                                                                                                              [, ]+
                                                                                                                                                                                                                                                                                                                              which is how Ant, by default, handles multiple patterns in a single string.

                                                                                                                                                                                                                                                                                                                              The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                          • useWorkspaceInPromotion

                                                                                                                                                                                                                                                                                                                            Set the root directory for the Source files to the workspace.

                                                                                                                                                                                                                                                                                                                            By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

                                                                                                                                                                                                                                                                                                                            If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

                                                                                                                                                                                                                                                                                                                            If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory

                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • usePromotionTimestamp

                                                                                                                                                                                                                                                                                                                            Use the build time of the promotion when the remote directory is a date format.

                                                                                                                                                                                                                                                                                                                            By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.

                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • ftpRetry

                                                                                                                                                                                                                                                                                                                            If publishing to this server fails, try again.

                                                                                                                                                                                                                                                                                                                            Files that were successfully transferred will not be re-sent.
                                                                                                                                                                                                                                                                                                                            If the Clean remote option is selected, and succeeds, it will not be attempted again.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • retries
                                                                                                                                                                                                                                                                                                                              The number of times to retry this server in the event of failure.
                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                            • retryDelay
                                                                                                                                                                                                                                                                                                                              The time to wait, in milliseconds, before attempting another transfer.
                                                                                                                                                                                                                                                                                                                              • Type: long
                                                                                                                                                                                                                                                                                                                          • ftpLabel

                                                                                                                                                                                                                                                                                                                            Set the label for this Server instance - for use with Parameterized publishing.

                                                                                                                                                                                                                                                                                                                            Expand the help for Parameterized publishing for more details.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • label

                                                                                                                                                                                                                                                                                                                              Set the label for this Server instance - for use with Parameterized publishing.

                                                                                                                                                                                                                                                                                                                              Expand the help for Parameterized publishing for more details.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                          • ftpCredentials
                                                                                                                                                                                                                                                                                                                            Set the username and password to use with this connection.

                                                                                                                                                                                                                                                                                                                            If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • username
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • password
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                        • continueOnError
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • failOnError
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • alwaysPublishFromMaster
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • masterNodeName
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • paramPublish
                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                          • parameterName
                                                                                                                                                                                                                                                                                                                            The name of the parameter or environment variable that will contain the expression for matching the labels.
                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                      • $class: 'BapSshBuilderPlugin'
                                                                                                                                                                                                                                                                                                                        Send files or execute commands over SSH as a build step during the build.
                                                                                                                                                                                                                                                                                                                        • publishers
                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                          • configName

                                                                                                                                                                                                                                                                                                                            Select an SSH configuration from the list configured in the global configuration of this Jenkins.

                                                                                                                                                                                                                                                                                                                            The configuration defines the connection properties and base directory of the SSH server.

                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                          • verbose
                                                                                                                                                                                                                                                                                                                            Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems.
                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • transfers
                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                            • sourceFiles

                                                                                                                                                                                                                                                                                                                              Files to upload to a server.

                                                                                                                                                                                                                                                                                                                              The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
                                                                                                                                                                                                                                                                                                                              The base directory for this fileset is the workspace.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • excludes

                                                                                                                                                                                                                                                                                                                              Exclude files from the Transfer set.

                                                                                                                                                                                                                                                                                                                              The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • remoteDirectory

                                                                                                                                                                                                                                                                                                                              Optional destination folder.

                                                                                                                                                                                                                                                                                                                              This folder will be below the one in the global configuration, if present.
                                                                                                                                                                                                                                                                                                                              The folder will be created if does not exist.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • removePrefix

                                                                                                                                                                                                                                                                                                                              First part of the file path that should not be created on the remote server.

                                                                                                                                                                                                                                                                                                                              Directory structures are created relative to the base directory, which is usually the workspace.
                                                                                                                                                                                                                                                                                                                              You normally do not want the full path to these files to be created on the server.
                                                                                                                                                                                                                                                                                                                              For example if Source files were target/deployment/images/**/ then you may want Remove prefix to be target/deployment This would create the images folder under the remote directory, and not target/deployment
                                                                                                                                                                                                                                                                                                                              Jenkins environment variables can be used in this path.

                                                                                                                                                                                                                                                                                                                              If you use remove prefix, then ALL source file paths MUST start with the prefix.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • remoteDirectorySDF

                                                                                                                                                                                                                                                                                                                              Select this to include the timestamp in the remote directory.

                                                                                                                                                                                                                                                                                                                              The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
                                                                                                                                                                                                                                                                                                                              This setting turns the remote directory option into a java SimpleDateFormat.
                                                                                                                                                                                                                                                                                                                              The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
                                                                                                                                                                                                                                                                                                                              As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.

                                                                                                                                                                                                                                                                                                                              Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.

                                                                                                                                                                                                                                                                                                                              Remote directory Directories created
                                                                                                                                                                                                                                                                                                                              'qa-approved/'yyyyMMddHHmmss qa-approved/20101107154555
                                                                                                                                                                                                                                                                                                                              'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' builds/2010/11/07/build-456 (if the build was number 456)
                                                                                                                                                                                                                                                                                                                              yyyy_MM/'build'-EEE-d-HHmmss 2010_11/build-Sun-7-154555
                                                                                                                                                                                                                                                                                                                              yyyy-MM-dd_HH-mm-ss 2010-11-07_15-45-55

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • flatten

                                                                                                                                                                                                                                                                                                                              Only create files on the server, don't create directories (except for the remote directory, if present).

                                                                                                                                                                                                                                                                                                                              All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • cleanRemote
                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • noDefaultExcludes
                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • makeEmptyDirs

                                                                                                                                                                                                                                                                                                                              The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
                                                                                                                                                                                                                                                                                                                              Selecting this option will create any directories that match the Source files pattern, even if empty.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • patternSeparator

                                                                                                                                                                                                                                                                                                                              The regular expression that is used to separate the Source files and Exclude files patterns.

                                                                                                                                                                                                                                                                                                                              The Source files and Exclude files both accept multiple patterns that by default are split using

                                                                                                                                                                                                                                                                                                                              [, ]+
                                                                                                                                                                                                                                                                                                                              which is how Ant, by default, handles multiple patterns in a single string.

                                                                                                                                                                                                                                                                                                                              The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • execCommand (optional)

                                                                                                                                                                                                                                                                                                                              A command to execute on the remote server.

                                                                                                                                                                                                                                                                                                                              This command will be executed on the remote server after any files are transferred.
                                                                                                                                                                                                                                                                                                                              The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • execTimeout (optional)

                                                                                                                                                                                                                                                                                                                              Timeout in milliseconds for the Exec command.

                                                                                                                                                                                                                                                                                                                              Set to zero to disable.

                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                            • usePty (optional)

                                                                                                                                                                                                                                                                                                                              Exec the command in a pseudo tty.

                                                                                                                                                                                                                                                                                                                              This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
                                                                                                                                                                                                                                                                                                                              From the sudoers(5) man page:

                                                                                                                                                                                                                                                                                                                              requiretty      If set, sudo will only run when the user is logged in
                                                                                                                                                                                                                                                                                                                                              to a real tty.  When this flag is set, sudo can only be
                                                                                                                                                                                                                                                                                                                                              run from a login session and not via other means such
                                                                                                                                                                                                                                                                                                                                              as cron(8) or cgi-bin scripts.  This flag is off by
                                                                                                                                                                                                                                                                                                                                              default.
                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • useAgentForwarding (optional)

                                                                                                                                                                                                                                                                                                                              Exec the command using Agent Forwarding.

                                                                                                                                                                                                                                                                                                                              Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.

                                                                                                                                                                                                                                                                                                                              From the ssh(1) man page:

                                                                                                                                                                                                                                                                                                                                      Enables forwarding of the authentication agent connection.  This can also be specified on a per-host basis in a configuration file.
                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                      Agent forwarding should be enabled with caution.  Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection.
                                                                                                                                                                                                                                                                                                                                      An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
                                                                                                                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • useSftpForExec (optional)

                                                                                                                                                                                                                                                                                                                              Using SFTP protocol instead of SSH for Exec command.

                                                                                                                                                                                                                                                                                                                              Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                          • useWorkspaceInPromotion

                                                                                                                                                                                                                                                                                                                            Set the root directory for the Source files to the workspace.

                                                                                                                                                                                                                                                                                                                            By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.

                                                                                                                                                                                                                                                                                                                            If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.

                                                                                                                                                                                                                                                                                                                            If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.

                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • usePromotionTimestamp

                                                                                                                                                                                                                                                                                                                            Use the build time of the promotion when the remote directory is a date format.

                                                                                                                                                                                                                                                                                                                            By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.

                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                          • sshRetry

                                                                                                                                                                                                                                                                                                                            If publishing to this server or command execution fails, try again.

                                                                                                                                                                                                                                                                                                                            Files that were successfully transferred will not be re-sent.
                                                                                                                                                                                                                                                                                                                            If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • retries
                                                                                                                                                                                                                                                                                                                              The number of times to retry this server in the event of failure.
                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                            • retryDelay
                                                                                                                                                                                                                                                                                                                              The time to wait, in milliseconds, before attempting another transfer.
                                                                                                                                                                                                                                                                                                                              • Type: long
                                                                                                                                                                                                                                                                                                                          • sshLabel

                                                                                                                                                                                                                                                                                                                            Set the label for this Server instance - for use with Parameterized publishing.

                                                                                                                                                                                                                                                                                                                            Expand the help for Parameterized publishing for more details.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • label

                                                                                                                                                                                                                                                                                                                              Set the label for this Server instance - for use with Parameterized publishing.

                                                                                                                                                                                                                                                                                                                              Expand the help for Parameterized publishing for more details.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                          • sshCredentials
                                                                                                                                                                                                                                                                                                                            Set the credentials to use with this connection.

                                                                                                                                                                                                                                                                                                                            If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.

                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                            • username
                                                                                                                                                                                                                                                                                                                              The username to connect with.
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • encryptedPassphrase
                                                                                                                                                                                                                                                                                                                              The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
                                                                                                                                                                                                                                                                                                                              Leave blank if the key is not encrypted.
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • key

                                                                                                                                                                                                                                                                                                                              The private key.

                                                                                                                                                                                                                                                                                                                              Paste the private key here, or provide the path to the file containing the key in Path to key.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                            • keyPath

                                                                                                                                                                                                                                                                                                                              The path to the private key.

                                                                                                                                                                                                                                                                                                                              Either supply the path to the file containing the key, or paste the key into the Key box.
                                                                                                                                                                                                                                                                                                                              The Path to key can be absolute, or relative to $JENKINS_HOME

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                        • continueOnError
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • failOnError
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • alwaysPublishFromMaster
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • masterNodeName
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • paramPublish
                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                          • parameterName
                                                                                                                                                                                                                                                                                                                            The name of the parameter or environment variable that will contain the expression for matching the labels.
                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                      • batchFile
                                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • configuredLocalRules (optional)
                                                                                                                                                                                                                                                                                                                            Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                          • retainOnlyVariables

                                                                                                                                                                                                                                                                                                                            Limit which environment variables are passed to a build step.

                                                                                                                                                                                                                                                                                                                            Environment variables passed to the build step are filtered, unless listed below.

                                                                                                                                                                                                                                                                                                                            The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:

                                                                                                                                                                                                                                                                                                                            • If the environment variable originates from Jenkins configuration, such as JOB_URL, it will not be passed to the build step unless specified here.
                                                                                                                                                                                                                                                                                                                            • If the environment variable originates from outside Jenkins, such as 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)
                                                                                                                                                                                                                                                                                                                              • Values: RESET, REMOVE
                                                                                                                                                                                                                                                                                                                            • retainCharacteristicEnvVars (optional)

                                                                                                                                                                                                                                                                                                                              When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.

                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                            • variables (optional)

                                                                                                                                                                                                                                                                                                                              Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.

                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                        • unstableReturn (optional)
                                                                                                                                                                                                                                                                                                                          If set, the batch errorlevel result that will be interpreted as an unstable build result. If the final errorlevel matches the value, the build results will be set to unstable and next steps will be continued. Supported values match the widest errorlevel range for Windows like systems. In Windows NT4 and beyond the ERRORLEVEL is stored as a four byte, signed integer, yielding maximum and minimum values of 2147483647 and -2147483648, respectively. Older versions of Windows use 2 bytes. DOS like systems use single byte, yielding errorlevels between 0-255. The value 0 is ignored and does not make the build unstable to keep the default behaviour consistent.
                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                      • $class: 'BeaglePlugin'
                                                                                                                                                                                                                                                                                                                        • apptoken

                                                                                                                                                                                                                                                                                                                          Generate your Application Token From Beagle

                                                                                                                                                                                                                                                                                                                          Home -> Applications -> Select your Application -> Settings -> Application Token
                                                                                                                                                                                                                                                                                                                          • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                        • accesstoken

                                                                                                                                                                                                                                                                                                                          Generate your Access Token From Beagle User Settings

                                                                                                                                                                                                                                                                                                                          Settings -> Access Token -> Generate Your New Personal Access Token
                                                                                                                                                                                                                                                                                                                          • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                      • $class: 'BeakerBuilder'
                                                                                                                                                                                                                                                                                                                        • jobSource
                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                          • $class: 'FileJobSource'
                                                                                                                                                                                                                                                                                                                            • jobPath
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                          • $class: 'StringJobSource'
                                                                                                                                                                                                                                                                                                                            • jobContent
                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                        • downloadFiles
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                      • $class: 'BeginAnalysis'
                                                                                                                                                                                                                                                                                                                        • logLevel
                                                                                                                                                                                                                                                                                                                          • Values: OFF, INFO, DEBUG, WARN, ERROR
                                                                                                                                                                                                                                                                                                                        • buildSessionId
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • appName
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • moduleName
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • branch
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • enableMultipleBuildFiles
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • overrideJars
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • multipleBuildFiles
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • labId
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • testStage
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • packagesIncluded
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • packagesExcluded
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • filesIncluded
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • filesExcluded
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • classLoadersExcluded
                                                                                                                                                                                                                                                                                                                          In order to exclude class loaders from the build, please provide comma separated list of class loaders names to exclude. Class loader name should be the class loader full package name. e.g. 'com.example.package.SomeClassLoader'
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • recursive
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • workspacepath
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • buildScannerJar
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • testListenerJar
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • testListenerConfigFile
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • autoRestoreBuildFile
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • sealightsMavenPluginInstallationArguments
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • buildFilesPatterns
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • buildFilesFolders
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • logEnabled
                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                        • logDestination
                                                                                                                                                                                                                                                                                                                          • Values: CONSOLE, FILE
                                                                                                                                                                                                                                                                                                                        • logFolder
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • buildStrategy
                                                                                                                                                                                                                                                                                                                          • Values: ONE_BUILD, BUILD_EACH_MODULE
                                                                                                                                                                                                                                                                                                                        • slMvnPluginVersion
                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                        • buildName
                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                          • $class: 'DefaultBuildName'
                                                                                                                                                                                                                                                                                                                            • $class: 'EmptyBuildName'
                                                                                                                                                                                                                                                                                                                              • $class: 'LatestBuildName'
                                                                                                                                                                                                                                                                                                                                • $class: 'ManualBuildName'
                                                                                                                                                                                                                                                                                                                                  • insertedBuildName
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                • $class: 'UpstreamBuildName'
                                                                                                                                                                                                                                                                                                                                  • upstreamProjectName
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                              • executionType
                                                                                                                                                                                                                                                                                                                                • Values: FULL, TESTS_ONLY, ONLY_LISTENER
                                                                                                                                                                                                                                                                                                                              • override_customerId
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • override_url
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • override_proxy
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • additionalArguments
                                                                                                                                                                                                                                                                                                                                This section allows you to add additional arguments, as key-value pairs.
                                                                                                                                                                                                                                                                                                                                Example for additional arguments:

                                                                                                                                                                                                                                                                                                                                server=https://prod-sealights-gw.sealights.co
                                                                                                                                                                                                                                                                                                                                proxy=http://localhost:8888

                                                                                                                                                                                                                                                                                                                                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)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • includeResources
                                                                                                                                                                                                                                                                                                                                When checked, the build session id and token files will be added to the artifacts as as resources in the folder.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                            • benchmark
                                                                                                                                                                                                                                                                                                                              • filepath
                                                                                                                                                                                                                                                                                                                                Please insert a filepath.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BitbucketPublisher'
                                                                                                                                                                                                                                                                                                                              • serverUrl (optional)
                                                                                                                                                                                                                                                                                                                                Bitbucket Server Url.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                Credentials for bitucket server. The user must have access to create project and repository.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • projectKey (optional)
                                                                                                                                                                                                                                                                                                                                Input the project key for the bitbucket.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • createProject (optional)
                                                                                                                                                                                                                                                                                                                                Check this if you want to create the bitbucket project.
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • projectName
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • projectUsers
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • projectGroups
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                              • createJenkinsJobs (optional)
                                                                                                                                                                                                                                                                                                                                Check this if you want to use the bitbucket post commit external hook to call.
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • ciServer
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                              • projectName (optional)
                                                                                                                                                                                                                                                                                                                                Input name of the Bitbucket project.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BladeBuilder'
                                                                                                                                                                                                                                                                                                                              • blades
                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                • $class: 'CodeScan'
                                                                                                                                                                                                                                                                                                                                  • source
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • exclude
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • noCache
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • noProxy
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • noBlame
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • ruleset
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • severityLevel
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • severityThreshold
                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                  • autoUpdate (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • debug (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • directory (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • environment (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • forceVersion (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • ignoreFailure (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • onFailureCmd (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • timeout (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                • $class: 'ImageScan'
                                                                                                                                                                                                                                                                                                                                  • image
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • exclude
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • noCache
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • noProxy
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • noBlame
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • ruleset
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • severityLevel
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • severityThreshold
                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                  • autoUpdate (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • debug (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • directory (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • environment (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • forceVersion (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • ignoreFailure (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • onFailureCmd (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • timeout (optional)
                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                            • $class: 'BlueprintLaunch'
                                                                                                                                                                                                                                                                                                                              • projectName

                                                                                                                                                                                                                                                                                                                                Project selection is mandatory.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • blueprintName

                                                                                                                                                                                                                                                                                                                                Blueprint selection is mandatory.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • applicationName

                                                                                                                                                                                                                                                                                                                                Application Name is mandatory.

                                                                                                                                                                                                                                                                                                                                This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • appProfileName

                                                                                                                                                                                                                                                                                                                                Application Profile selection is mandatory.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • actionName

                                                                                                                                                                                                                                                                                                                                The field is mandatory


                                                                                                                                                                                                                                                                                                                                Select the required action need to run after the application launch from the list of actions, else please select none.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • runtimeVariables

                                                                                                                                                                                                                                                                                                                                Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • waitForSuccessFulLaunch
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • blueprintDescription

                                                                                                                                                                                                                                                                                                                                Description is fetched from the selected Calm blueprint

                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BootPluginBuilder'
                                                                                                                                                                                                                                                                                                                              • tasks
                                                                                                                                                                                                                                                                                                                                Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • jvmOpts
                                                                                                                                                                                                                                                                                                                                Specify JVM Options to be used within boot tasks.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BranchDestructionStep'
                                                                                                                                                                                                                                                                                                                              • project
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • branch
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BranchGenerationStep'
                                                                                                                                                                                                                                                                                                                              • projectConfig
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • pipelineConfig
                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                  • destructor
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • authorisations
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • branchSCMParameter
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • branchParameters
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • generationExtension
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • pipelineGenerationExtension
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • disableDslScript
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                  • scriptDirectory
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • namingStrategy
                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                    • projectFolderPath
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • branchFolderPath
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • projectSeedName
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • projectDestructorName
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • branchSeedName
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • branchStartName
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • branchName
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                    • ignoredBranchPrefixes
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                  • eventStrategy
                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                    • delete
                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                    • auto
                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                    • trigger
                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                    • commit
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                • project
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • scmType
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • scmUrl
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • scmCredentials
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • triggerIdentifier
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • triggerType
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • triggerSecret
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                            • dotnetBuild
                                                                                                                                                                                                                                                                                                                              The dotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
                                                                                                                                                                                                                                                                                                                              1. An executable that can be used to run the application, if the project type is an executable targeting .NET Core 3.0 or later.
                                                                                                                                                                                                                                                                                                                              2. Symbol files used for debugging, with a .pdb extension.
                                                                                                                                                                                                                                                                                                                              3. A .deps.json file, which lists the dependencies of the application or library.
                                                                                                                                                                                                                                                                                                                              4. A .runtimeconfig.json file, which specifies the shared runtime and its version for an application.
                                                                                                                                                                                                                                                                                                                              5. Other libraries that the project depends on (via project references or NuGet package references).
                                                                                                                                                                                                                                                                                                                              • configuration (optional)
                                                                                                                                                                                                                                                                                                                                Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • force (optional)
                                                                                                                                                                                                                                                                                                                                Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • framework (optional)
                                                                                                                                                                                                                                                                                                                                Compiled for a specific framework. The framework must be defined in the project file.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • noDependencies (optional)
                                                                                                                                                                                                                                                                                                                                Ignores project-to-project references and only restores the root project.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • noIncremental (optional)
                                                                                                                                                                                                                                                                                                                                Marks the build as unsafe for incremental build. This flag turns off incremental compilation and forces a clean rebuild of the project's dependency graph.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • noRestore (optional)
                                                                                                                                                                                                                                                                                                                                Doesn't execute an implicit restore when running the command.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • nologo (optional)
                                                                                                                                                                                                                                                                                                                                Doesn't display the startup banner or the copyright message.

                                                                                                                                                                                                                                                                                                                                Available since: .NET Core SDK 3.0
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • option (optional)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • options (optional)
                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                              • optionsString (optional)
                                                                                                                                                                                                                                                                                                                                For more information about these options, see the MSBuild Command-Line Reference.
                                                                                                                                                                                                                                                                                                                                If targets and/or properties are also configured, those will be passed after these options.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • outputDirectory (optional)
                                                                                                                                                                                                                                                                                                                                Directory in which to place the built binaries. If not specified, the default path is ./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.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • project (optional)
                                                                                                                                                                                                                                                                                                                                The MSBuild project or solution to build. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • properties (optional)
                                                                                                                                                                                                                                                                                                                                • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                                              • propertiesString (optional)
                                                                                                                                                                                                                                                                                                                                Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • runtime (optional)
                                                                                                                                                                                                                                                                                                                                Specifies the target runtime. For a list of Runtime Identifiers (RIDs), see the RID catalog.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • sdk (optional)
                                                                                                                                                                                                                                                                                                                                Name of a .NET SDK to use so that dotnet will be in the path.
                                                                                                                                                                                                                                                                                                                                If the default is specified, you either need to use the With .NET element (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.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • showSdkInfo (optional)
                                                                                                                                                                                                                                                                                                                                If enabled, 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.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • shutDownBuildServers (optional)
                                                                                                                                                                                                                                                                                                                                If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
                                                                                                                                                                                                                                                                                                                                Note: If this is not specified, a build that causes such a build server to be started may hang until 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).

                                                                                                                                                                                                                                                                                                                                Available since: .NET Core SDK 2.1
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • specificSdkVersion (optional)
                                                                                                                                                                                                                                                                                                                                Depending on the platform, the 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.
                                                                                                                                                                                                                                                                                                                                By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
                                                                                                                                                                                                                                                                                                                                Note: This will silently overwrite any global.json already present in the current directory.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • target (optional)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • targets (optional)
                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                              • targetsString (optional)
                                                                                                                                                                                                                                                                                                                                Specifies the MSBuild targets to build. If none are specified, the default target specified in the project will be built.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • unstableIfWarnings (optional)
                                                                                                                                                                                                                                                                                                                                If this is set and the build completes successfully with warnings, the build will be marked as unstable.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • verbosity (optional)
                                                                                                                                                                                                                                                                                                                                Sets the MSBuild verbosity level.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • versionSuffix (optional)
                                                                                                                                                                                                                                                                                                                                Sets the value of the $(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.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • workDirectory (optional)
                                                                                                                                                                                                                                                                                                                                The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • buildAddUrl
                                                                                                                                                                                                                                                                                                                              • title
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • url
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BuildBuilder'
                                                                                                                                                                                                                                                                                                                              • dbFolder
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                                  • Values: vcsroot, subfolder, scaproject
                                                                                                                                                                                                                                                                                                                                • subfolder
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • projectPath
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                              • packageid
                                                                                                                                                                                                                                                                                                                                Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • tempServer
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • serverName
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • dbName
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • serverAuth
                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                  • value
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • username
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • password
                                                                                                                                                                                                                                                                                                                                    • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                                • encryptConnection
                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                • trustServerCertificate
                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                              • options
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • dataOptions
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • transactionIsolationLevel
                                                                                                                                                                                                                                                                                                                                • Values: Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommitted
                                                                                                                                                                                                                                                                                                                              • filter
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • packageVersion
                                                                                                                                                                                                                                                                                                                                Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • dlmDashboard
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • dlmDashboardHost
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                • dlmDashboardPort
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                              • sqlChangeAutomationVersionOption
                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                • value
                                                                                                                                                                                                                                                                                                                                  • Values: Latest, Specific
                                                                                                                                                                                                                                                                                                                                • specificVersion
                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                            • buildDescription
                                                                                                                                                                                                                                                                                                                              Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.
                                                                                                                                                                                                                                                                                                                              • descriptionTemplate
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • buildName
                                                                                                                                                                                                                                                                                                                              Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.
                                                                                                                                                                                                                                                                                                                              • nameTemplate
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BuildNameUpdater'
                                                                                                                                                                                                                                                                                                                              This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.
                                                                                                                                                                                                                                                                                                                              • fromFile
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • buildName
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • fromMacro
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • macroTemplate
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • macroFirst
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                            • crxBuild
                                                                                                                                                                                                                                                                                                                              Create and build a content package on CRX by specifying a workspace filter, and then download it to the workspace to get archived as a backup, or as the beginning of a magical content package adventure, full of drama, suspense, and deployments to lower environments!
                                                                                                                                                                                                                                                                                                                              • packageId (optional)
                                                                                                                                                                                                                                                                                                                                Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

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

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

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

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

                                                                                                                                                                                                                                                                                                                                http://deployer@localhost:4502

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

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

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

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

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

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

                                                                                                                                                                                                                                                                                                                                For example, to include everything under /etc except for packages:

                                                                                                                                                                                                                                                                                                                                        /etc                 # define /etc as the filter root
                                                                                                                                                                                                                                                                                                                                        +/etc(/.*)?          # include everything under /etc
                                                                                                                                                                                                                                                                                                                                        -/etc/packages(/.)?  # exclude package paths
                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                To create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:

                                                                                                                                                                                                                                                                                                                                        /content/acme        # include the site content
                                                                                                                                                                                                                                                                                                                                        /apps/acme           # include the app code
                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                This field supports parameter tokens.
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BuildScanner'
                                                                                                                                                                                                                                                                                                                              Trigger automated Acunetix scans as part of your web application's build process
                                                                                                                                                                                                                                                                                                                              • profile
                                                                                                                                                                                                                                                                                                                                The Scan Type used to scan the target
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • target
                                                                                                                                                                                                                                                                                                                                The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • repTemp
                                                                                                                                                                                                                                                                                                                                Generate a Report after the scan completes. The report is available for download from Acunetix backend within a time frame of one hour
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • threat
                                                                                                                                                                                                                                                                                                                                The Threat Level (High, Medium, Low) to fail the build on
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • stopScan
                                                                                                                                                                                                                                                                                                                                If selected, the scan will be stopped if the build fails (Threat Level is reached)
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • svRep
                                                                                                                                                                                                                                                                                                                                Option to download the report in the project workspace from where it can be used for other operations like attaching to an email or archiving.
                                                                                                                                                                                                                                                                                                                                Note: Archiving can be done with "Archive the artifacts" post-build action
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • incScan
                                                                                                                                                                                                                                                                                                                                This will create an Incremental scan. The first scan will scan all the site. Subsequent scans will only scan the changes in the site, resulting in smaller scans.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                              • incScanId
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • stopTargetScans
                                                                                                                                                                                                                                                                                                                                This is useful when older versions of the web application are discarded by the CI/CD when an updated version is created.
                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                            • $class: 'BuildStepBuilder'
                                                                                                                                                                                                                                                                                                                              • sourceFolderMode
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • subfolder
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • packageId
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • serverType
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • server
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • authenticationType
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • userName
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • password
                                                                                                                                                                                                                                                                                                                                • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                              • database
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • compareOptions (optional)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • filterFile (optional)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                              • transactionIsoLvl (optional)
                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                            • $class: 'BuildStepWithTimeout'
                                                                                                                                                                                                                                                                                                                              • buildStep
                                                                                                                                                                                                                                                                                                                                • Type: Build Step (hudson.tasks.BuildStep)
                                                                                                                                                                                                                                                                                                                              • strategy
                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                • $class: 'AbsoluteTimeOutStrategy'

                                                                                                                                                                                                                                                                                                                                  Abort build based on a fixed time-out.

                                                                                                                                                                                                                                                                                                                                  • timeoutMinutes
                                                                                                                                                                                                                                                                                                                                    If configured, and if a build does not complete by the specified amount of time (in minutes; at least 3), then the build will be terminated automatically and marked as aborted. This is useful if you have experienced infinite loops in your test, for example.
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                • $class: 'DeadlineTimeOutStrategy'

                                                                                                                                                                                                                                                                                                                                  Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).

                                                                                                                                                                                                                                                                                                                                  • deadlineTime
                                                                                                                                                                                                                                                                                                                                    If configured, and if a build does not complete by next deadline time (specified in 24-hour format as HH:MM:SS or HH:MM), then the build will be terminated automatically and marked as indicated in the time-out actions ("aborted" by default).
                                                                                                                                                                                                                                                                                                                                    Variable references are allowed to define deadline time.
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • deadlineToleranceInMinutes
                                                                                                                                                                                                                                                                                                                                    Period in minutes after the deadline time when a job should be immediately aborted. E.g. if deadline is defined as "13:50", tolerance as "5" minutes and job is scheduled to run at "13:52" it will be immediately aborted. However if it is scheduled at "13:56", job's deadline will be set at "13:50" of next day.
                                                                                                                                                                                                                                                                                                                                    • Type: 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
                                                                                                                                                                                                                                                                                                                                    If the build duration lasts longer than this percentage of the three most recent non-failing builds, the build will be terminated and marked as aborted. If there are no successful builds, the "Timeout minutes if no successful or unstable builds" field will be used instead.
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • timeoutMinutesElasticDefault
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • numberOfBuilds
                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                  • failSafeTimeoutDuration
                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                • $class: 'LikelyStuckTimeOutStrategy'

                                                                                                                                                                                                                                                                                                                                  Abort the build when the job has taken many times longer than previous runs.

                                                                                                                                                                                                                                                                                                                                  • $class: 'NoActivityTimeOutStrategy'
                                                                                                                                                                                                                                                                                                                                    Timeout when specified seconds has passed since the last log output.
                                                                                                                                                                                                                                                                                                                                    • timeoutSecondsString
                                                                                                                                                                                                                                                                                                                                      Seconds to detect timeout since the last log output. This is useful to abort a build if no activity for long time. Be careful with log output delay for buffering.
                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                  • $class: 'RunConditionTimeoutStrategy'
                                                                                                                                                                                                                                                                                                                                    Sets a conditional timeout. The strategy will take a timeout from a first matching condition. The default value will be used if all evaluations fail or return false.

                                                                                                                                                                                                                                                                                                                                    This extension uses run condition as condition sources.

                                                                                                                                                                                                                                                                                                                                    • conditions
                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                        A Run Condition to be evaluated.
                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                            • conditions
                                                                                                                                                                                                                                                                                                                                                Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                  • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                  • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                  • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                    • token
                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                  • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                    Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                    • buildCause
                                                                                                                                                                                                                                                                                                                                                      The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                      • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                      • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                      • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                      • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                      • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                      • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                      The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                      • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                      • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                      • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                      • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                      • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                    • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                  • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                    • useBuildTime
                                                                                                                                                                                                                                                                                                                                                      Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                      For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                    • daySelector
                                                                                                                                                                                                                                                                                                                                                      For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                      Weekends
                                                                                                                                                                                                                                                                                                                                                      Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                      Weekdays
                                                                                                                                                                                                                                                                                                                                                      Not a weekend
                                                                                                                                                                                                                                                                                                                                                      Select days
                                                                                                                                                                                                                                                                                                                                                      Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                      • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                        • days
                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                          • day
                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                          • selected
                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                        • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                        • expression
                                                                                                                                                                                                                                                                                                                                                          The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                        • label
                                                                                                                                                                                                                                                                                                                                                          The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                          • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                            • projects
                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                          • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                            • users
                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                      • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                        • file
                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                        • baseDir
                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                          • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                            • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                              • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                            • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                  • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                    • invert
                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                      • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                        • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                      • lhs
                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                      • rhs
                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                      • comparator
                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                    • value
                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                  • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                    Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                    You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                    For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                            BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                            BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                    would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                            ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                    In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                    • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                    • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                    • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                    • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                    Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • latest
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                  • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                    • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Timeout in minutes, which will be set if the condition above returns true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • defaultTimeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A default timeout in minutes. This value will be used if all condition evaluations fail or return false.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • operationList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'AbortAndRestartOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • maxRestarts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Count of maximum restarts. 0 means without a limit.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'AbortOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Abort the build. This is a default operation performed if no operations are specified.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'BuildStepOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Perform a build step or a post-build action as a timeout action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This never ensure all build steps and post-build actions works correct.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildstep
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: Build Step (hudson.tasks.BuildStep)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • continueEvenFailed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Continue subsequent timeout actions even when the build step failed. If unchecked, subsequent timeout actions is not executed, and the build will be marked as failure.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • createLauncher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Build steps like "Execute shell", "Execute Windows batch command" and so on, requires Launcher object to execute an external program. Build Timeout does not provide Launcher for build steps by default and those build steps fail. Checking here provides the build step a new created Launcher. You should not check here as long as the build step can run without this (that is, it does not require an external program).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FailOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The build will be marked as failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'WriteDescriptionOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writing the build description.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A description to set. {0} will be replaced with timeout minutes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BuildStepsFromJsonBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BuildoutBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pythonName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buildoutCfg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • nature
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ignoreExitCode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • byteguardGreet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • task_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CFLaunchBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cfComposition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • setCFVars
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • vars
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Variable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CIMessageBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • providerData (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • activeMQPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageProperties (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageType (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type of CI message to be sent.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • activeMQSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • selector (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          JMS selector to choose messages that will fire the trigger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • fedmsgPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • fedmsgSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rabbitMQPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fedoraMessaging (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • schema (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Path to message schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • severity (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Severity of the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rabbitMQSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: 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)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • activeMQPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageProperties (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageType (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type of CI message to be sent.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • activeMQSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • selector (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          JMS selector to choose messages that will fire the trigger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • fedmsgPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • fedmsgSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message matching the specified JMS selector.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rabbitMQPublisher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • failOnError (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether you want to fail the build if there is an error sending a message. By default, it is false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fedoraMessaging (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageContent (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • schema (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Path to message schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • severity (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Severity of the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rabbitMQSubscriber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checks (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • field
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expectedValue
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • overrides (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • topic (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Value (in minutes) to wait for a message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Environment variable to hold received message content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CToolBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Executes a tool of the CMake-suite with arbitrary command-line arguments.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Useful to run cmake in script mode (cmake -P <script file>) or command mode (cmake -E <command>).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • installationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • arguments (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ignoredExitCodes (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • toolId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • workingDir (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • generateCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • caches
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Values: A2L, ELF, BUS, MODEL, SERVICE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • filePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • dbChannel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • clear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CallFunction'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Call a function You can choose:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Function name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Function Arguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • functionName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • argumentList (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • argument (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CallOtherJenkinsBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • hostName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • jobName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • span
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • retry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • userName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CaptureIOSDeviceScreenshot'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cloudTestServerID
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select the server to download iOSAppInstaller.zip from.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • additionalOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • carbonetes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • engineTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • failBuildOnPluginError (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • failBuildOnPolicyEvaluationFailResult (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • image (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • policyBundleID (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • registryURI (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • carl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • installationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • sourcePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • applicationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • archivePdf (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • displayLog (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • logPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outputPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • qualityGate (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • castecho
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • installationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • sourcePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • applicationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • displayLog (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • logPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outputPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • qualityGate (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • venafiVcertRequestCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • connectorName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • zoneConfigName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • commonName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • privKeyOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • certOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • certChainOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • country (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • dnsNames (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • hostName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • emailAddresses (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ipAddresses (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • keyType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Values: RSA, ECDSA
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • locality (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • organization (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • organizationalUnit (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • province (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • changeAsmVer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This build step can be used to change the version in the AssemblyInfo.cs file from a .NET Project, it's going to find every AssemblyInfo.cs file in the workspace and change the version from [AssemblyVersion] and [AssemblyFileVersion] attributes. It's recommended to use this plugin with the auto-generated AssemblyInfo.cs from VisualStudio.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • versionPattern
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyCompany (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyCopyright (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyCulture (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyDescription (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyFile (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyProduct (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyTitle (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • assemblyTrademark (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • regexPattern (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • replacementPattern (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ChangeEventBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create Change Events on PagerDuty services as Jenkins build steps.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integrationKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This is the 32 character Integration Key for an Integration on a Service.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • summaryText (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This is an alternate summary text, that can be passed onto Pager duty change events. If omitted it will default to current build's fullDisplayName.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • chatterPost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Simple step for posting a Chatter buildUrlTitle/body to a specified channel or the user's wall.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Usage Example:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Identity Confirmation in the salesforce.com online help for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The body text for your Chatter post
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buildUrlTitle (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • recordId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • server (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CheckGate'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pipelineId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • stageName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • versionId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fatal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CheckGateBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select project.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • gate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ChefBuilderConfiguration'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • sinatraurl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • username
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • privatekey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • parallel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fail
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • chlAtuoAction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • content
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • browserString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • runScriptOnly
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • rootPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • libPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ChrootBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • chrootName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ignoreExit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The build will always succeed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • additionalPackages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • packagesFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • clear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • loginAsRoot
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • noUpdate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • forceInstall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CifsBuilderPlugin'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • publishers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • configName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • verbose
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • transfers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sourceFiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • remoteDirectory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • removePrefix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • remoteDirectorySDF
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • flatten
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • cleanRemote
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • noDefaultExcludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • makeEmptyDirs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • patternSeparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • useWorkspaceInPromotion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • usePromotionTimestamp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • retry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • retryDelay
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • continueOnError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • failOnError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • alwaysPublishFromMaster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • masterNodeName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • paramPublish
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • parameterName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ClangScanBuildBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use this option to execute clang scan-build against and XCode project.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • target
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • targetSdk
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      xcodebuild -showsdks

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outputFolderName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • googleStorageUpload
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • bucket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pattern
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pathPrefix (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • sharedPublicly (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • showInline (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • dotnetClean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The dotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • configuration (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Defines the build configuration. The default for most projects is 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • framework (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The framework that was specified at build time. The framework must be defined in the project file. If you specified the framework at build time, you must specify the framework when cleaning.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • nologo (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Doesn't display the startup banner or the copyright message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Available since: .NET Core SDK 3.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • option (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • options (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • optionsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For more information about these options, see the MSBuild Command-Line Reference.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If targets and/or properties are also configured, those will be passed after these options.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outputDirectory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The directory that contains the build artifacts to clean. If you specified the framework when the project was built, that same framework should also be specified for this cleanup action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • project (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The MSBuild project or solution to clean. If a directory is specified, MSBuild searches it for a (single) file that has a file extension that ends in proj or sln, and uses that file. If nothing is specified, the current working directory is searched in the same way.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • properties (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • propertiesString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Additional MSBuild properties to set. These should be specified one per line, in Java properties syntax.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • runtime (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Cleans the output folder of the specified runtime. This is used when a self-contained deployment was created.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • sdk (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name of a .NET SDK to use so that dotnet will be in the path.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If the default is specified, you either need to use the With .NET element (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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • showSdkInfo (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If enabled, 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • shutDownBuildServers (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If enabled, dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Note: If this is not specified, a build that causes such a build server to be started may hang until 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).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Available since: .NET Core SDK 2.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • specificSdkVersion (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Depending on the platform, the 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Note: This will silently overwrite any global.json already present in the current directory.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • unstableIfWarnings (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If this is set and the build completes successfully with warnings, the build will be marked as unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • verbosity (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets the MSBuild verbosity level.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • workDirectory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • examCleanTarget
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • validNetwork
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • username
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • projectId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • filepath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ClifBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • clifName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • clifOpts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • testPlanFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • reportDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CloudBuildBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This build step invokes Google Cloud Build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • input
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • filename
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The path to the YAML build request file to pass to Google Cloud Build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • inline
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The YAML Build Request to pass to Google Cloud Build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • source (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • local
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The source to use in the build request. This may be either:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • A path to a file within the workspace. The file must be a compressed gzipped tarball (.tgz or .tar.gz) or zip file (.zip), or
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • A path to a directory within the workspace. The contents of the directory will be archived as a gzipped tarball (.tgz) and uploaded to a temporary Cloud Storage bucket.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • repo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • branch (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • commit (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • projectId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ID of the project that owns the repo. If omitted, the project ID requesting the build is assumed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • repoName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name of the repo. If omitted, the name "default" is assumed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • tag (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bucket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • substitutionList (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the user-defined substitution. This must begin with an underscore (_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • substitutions (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pushToCloudFoundry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • target
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cloudSpace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • manifestChoice (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • appName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • appPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • buildpack (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • command (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • domain (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • envVars (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • hostname (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • instances (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • manifestFile (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • memory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • noRoute (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • servicesNames (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stack (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • timeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pluginTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • selfSigned (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • servicesToCreate (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • plan
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • resetService (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cloudhubDeployer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • environmentId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • orgId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • appName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The application name identifies your application not only in Runtime Manager but also in the public cloudhub.io domain. For example, an application named myapplication is accessible at http://myapplication.cloudhub.io. To avoid domain conflicts, the application name must be globally unique across CloudHub.The application name can contain between 3 and 42 alphanumeric characters (a-z, A-Z, 0-9) and dashes (-). They cannot contain spaces or other characters.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • muleVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The runtime version must be the same Mule version used to develop your application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • filePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Workspace-relative path of the artifact file to upload (it should resolve to a single file). Can use wildcards like module/dist/**/*.jar, See the @includes of Ant fileset for the exact format. Examples: File, like target/my-mule-app.jar or target/**/*.jar : The jar file will be uploaded to cloudhub.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Jenkins credentials containing The Anypoint Platform account username and password with sufficient access to perform deployment related activities on CloudHub.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • requestMode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type of Operation to perform on CloudHub. CREATE - Deploy/Create new application UPDATE - Update application with new package and settings provided. UPDATE_FILE - Update just the zip/jar file of application, rest all settings ignored. CREATE_OR_UPDATE - Deploy/Create new application(if not already present) or update the existing application. RESTART - Restart the application already present. DELETE - Delete the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Values: CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • region (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If you have global deployment enabled on your account, you can change the deployment region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • autoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • autoScalePolicyName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The auto scaling policy name.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enableAutoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • id (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • maxScale (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The maximum number of workers or size of workers for auto scaling. Allowed Values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • minScale (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The minimum number of workers or size of workers for auto scaling. Allowed values: 0.1, 0.2, 1, 2, 3, 4, 5, 6, 7, 8, 16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleBasedOn (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The metric based on which auto scaling policy scales. Allowed values: CPU, MEMORY
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleDown (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleDownNextScaleWaitMins (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of minutes to wait before applying new scale down policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleDownPeriodCount (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The time in minutes to monitor the CPU/memory for low usage before scaling down.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleDownValue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The CPU or memory usage below which scale down policy will take effect.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The scale type of the auto scaling policy. Allowed values: WORKER_COUNT, WORKER_SIZE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleUp (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleUpNextScaleWaitMins (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Number of minutes to wait before applying new scale up policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleUpPeriodCount (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The time in minutes to monitor the CPU/memory for high usage before scaling up.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • scaleUpValue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The CPU or memory usage above which scale up policy will take effect.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • autoStart (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this flag to autostart the application after it is deployed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • debugMode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Use this to log additional details/info from the http requests.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Values: ENABLED, DISABLED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enableAutoScalePolicy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • envVars (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        you can specify properties (key-value pairs) that the application uses during deployment and while running.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • key (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ignoreGlobalSettings (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If checked settings from global configuration will be used that are under manage jenkins.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • logLevels (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        You can configure the logging level (DEBUG, WARN, ERROR, or INFO) for the application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • levelCategory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Values: DEBUG, WARN, ERROR, INFO
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • packageName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • loggingNgEnabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this if you want to use your own logging solution using Log4j configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • monitoringAutoRestart (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CloudHub automatically restarts your application when the monitoring system discovers an issue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • monitoringEnabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Use Anypoint Monitoring and Visualizer for Mule applications running on supported versions of Mule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • objectStoreV1 (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object Store v2 is enabled by default in Mule 4. In Mule 3, select this option to use Object Store v1.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • persistentQueues (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        You can use persistent queues on your application to store data in an input queue to disk. Persistent queues protect against message loss and enable you to distribute workloads across a set of workers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • persistentQueuesEncrypted (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If you enable persistent queues, you can optionally encrypt the data stored in the input queue on disk.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • timeoutConnection (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Max time to try before failing the request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • timeoutResponse (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Max time to wait for response before failing the request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • verifyDeployments (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Verify if API is stated after deployment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • verifyIntervalInSeconds (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workerAmount (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        No of workers to run for API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workerCpu (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Compute Capacity for each worker(vCores). Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 2 or 16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workerMemory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Heap memory (Or Ram) for each worker. Check MuleSoft Documentation for available sizes (worker-size-and-vcores. Example Values :- "500 MB", "1.5 GB" or "32 GB"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workerType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type of worker to use "Micro", "Small", "Medium" or "Large". Check MuleSoft Documentation for additional details.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workerWeight (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Weight for worker type. Check MuleSoft Documentation for available sizes(worker-size-and-vcores). Example Values :- 0.1, 0.2 or 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CloudManagerBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • program (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pipeline (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CloudShellConfig'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildStep
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StartSandbox'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • blueprintName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the name or id of a CloudShell blueprint.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandboxDuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The sandbox duration in minuets.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • maxWaitForSandboxAvailability
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • setupTimeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the number of minutes to wait for the sandbox setup to complete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • params (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Blueprint Parameter in this syntax: "input1=my_name; input2=30"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandboxDomain (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sandbox will be created in the following domain.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandboxName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sandboxes will be created with this name instead of the blueprint name.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CmakeBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Uses CMake to generate build-scripts and can run these.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This causes Jenkins to invoke cmake -G with the given options.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Any non-zero exit code during build-script generation causes Jenkins to mark the build as a failure.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      It also can expose the CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • installationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildDir (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cleanBuild (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cmakeArgs (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • generator (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • preloadScript (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sourceDir (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • steps (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • args (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Specify arguments to pass to the build tool or to 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),
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Most of the time, you will want to leave this empty (to call the default build target) or you will specify just some build target names here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • envVars (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Specify extra environment variables to pass to the build tool as key-value pairs here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Each entry must be on its own line, for example:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DESTDIR=${WORKSPACE}/artifacts/dir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          KEY=VALUE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • withCmake (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Leave unchecked for minimal performance overhead.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Make it checked, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CocoaPodsBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cleanpods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If checked the "pod" folder will be deleted before updating the pods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CodeBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • proxyHost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • proxyPort
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • awsAccessKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • awsSecretKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • awsSessionToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • region
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • projectName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sourceVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sseAlgorithm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sourceControlType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • localSourcePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workspaceSubdir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • gitCloneDepthOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • reportBuildStatusOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • secondarySourcesOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • secondarySourcesVersionOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactTypeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactLocationOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactNameOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactNamespaceOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactPackagingOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactPathOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • artifactEncryptionDisabledOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • overrideArtifactName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • secondaryArtifactsOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • envVariables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • envParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildSpecFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildTimeoutOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sourceTypeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sourceLocationOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • environmentTypeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • imageOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • computeTypeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cacheTypeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cacheLocationOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cacheModesOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cloudWatchLogsStatusOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cloudWatchLogsGroupNameOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cloudWatchLogsStreamNameOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • s3LogsStatusOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • s3LogsEncryptionDisabledOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • s3LogsLocationOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • certificateOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serviceRoleOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • insecureSslOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • privilegedModeOverride
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cwlStreamingDisabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • exceptionFailureMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • downloadArtifacts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • downloadArtifactsRelativePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CodeCoverageBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • connectionId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • analysisPropertiesPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • analysisProperties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • codescene
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • deltaAnalysisUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • repository
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • analyzeBranchDiff (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • analyzeLatestIndividually (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Commits not seen in previous successful builds will be used for separate delta analyses.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseRevision (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • couplingThresholdPercent (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • failOnDecliningCodeHealth (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this option to mark the build as unstable if the Code Health of a hotspot declines.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • failOnFailedGoal (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • letBuildPassOnFailedAnalysis (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • markBuildAsUnstable (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • originUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • riskThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • useBiomarkers (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CodeStreamBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        vRealize Automation host.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • userName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        User name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • tenant
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tenant
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pipelineName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • waitExec
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pipelineParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CodefreshPipelineBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • selectPipeline
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • cfPipeline
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • cfBranch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • setCFVars
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vars
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Variable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CommentsRemoverBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • filename
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of the input file to have comments removed from
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Language of the input file - helps locate comments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • outputDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        After execution the result will be in this directory in the workspace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'CompoundBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ConditionalBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • runCondition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'AlwaysRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'And'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • conditions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BatchFileCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The script will be run with the workspace as the current directory. The text you enter in the text box will be executed as a batch file, and a result will be considered a false value if at the end of the execution %ERRORLEVEL% is not 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'BooleanCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Run if the current build has a specific cause (e.g triggered by SCM or timer).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • buildCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The cause why the build was triggered. The following causes are supported:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UserCause - the build was triggered by a manual interaction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCMTrigger - the build was triggered by a SCM change
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TimerTrigger - the build was triggered by a timer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CLICause - the build was triggered by via CLI interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoteCause - the build was triggered via remote interface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpstreamCause - the build was triggered by an upstream project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The following causes are supported if the XTrigger plugin is installed:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FSTrigger - the build was triggered by a file system change (FSTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URLTrigger - the build was triggered by a URL change (URLTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IvyTrigger - the build was triggered by an Ivy dependency version has change (IvyTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ScriptTrigger - the build was triggered by a script (ScriptTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BuildResultTrigger - the build was triggered by a result of an other job (BuildResultTrigger Plugin)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'DayCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • daySelector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For which days do you want the build to run?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekends
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saturday and Sunday
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Weekdays
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Not a weekend
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Select days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Choose the days for which the build should run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'SelectDays'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • day
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Weekday'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Weekend'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExpressionCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The regular expression used to match the label - Java regular expression syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The label that will be tested by the regular expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'ExtendedCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UpstreamCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of projects, which will cause a true result. If empty any upstream projects will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'UserBuildCauseCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Comma seperated list of users, which will cause a true result. If empty any user started build will return true.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • exclusiveCause
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                There might by multiple causes causing a build to be triggered, with this flag checked, the cause must be the only one causing this build to be triggered.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'FileExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'FilesMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • includes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • baseDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ArtifactsDir'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'JenkinsHome'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Workspace'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'LegacyBuildstepCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • condition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • invert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NeverRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NodeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowedNodes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Not'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'NumericalComparisonCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • rhs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • comparator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'EqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'GreaterThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'GreaterThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'LessThan'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'LessThanOrEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'NotEqualTo'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'OntrackDSLRunCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ontrackScriptLocation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scriptPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scriptText
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • sandbox
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the Ontrack DSL script will run in a Groovy sandbox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • injectEnvironment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Comma-separated list of environment variable (like 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}", '')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • injectProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  You can define variables to inject into the script by using a property-like format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  For example, the following text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BRANCH = 1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          BUILD = ${VERSION}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  would inject the corresponding BRANCH and BUILD variables in the script:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  In the text:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • declare properties using name = value syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • empty lines are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • lines started by # are ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • patterns like ${VAR} are expanded using VAR from the current environment variables.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ontrackLog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the connections (request + response) to Ontrack will be logged in the build console output.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'Or'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'ShellCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl) or control the options that shell uses. Default shell is the same as configured for the Execute shell build step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StatusCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • worstResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • bestResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The current build status must be equal to, or better than the Worst status and equal to, or worse than the Best status for the build step to run
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'StringsMatchCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • arg2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ignoreCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ignore the case of the strings when matching them
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TextFinderCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fileSet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • checkConsoleOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'TimeCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • earliest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • latest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • useBuildTime
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Use the build time instead of the the time that the condition is evaluated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For long running builds, there can be a considerable difference between these two times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'VariableExistsCondition'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the variable to be checked. Variables in this field will be expanded.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • runner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If the evaluation of a run condition fails, should the build fail, be marked unstable, run the build step ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'DontRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Fail'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'Run'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'RunUnstable'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'Unstable'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • conditionalbuilders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: Array / List of Build Step (hudson.tasks.BuildStep)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ConfigFileBuildStep'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Make globally configured files available in your local workspace. All files configured via the config-file-provider plugin are available and can be referenced.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • managedFiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • fileId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • replaceTokens (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Decides whether the token should be replaced using macro.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • targetLocation (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the file (with optional file relative to workspace directory) where the config file should be copied.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • variable (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the variable which can be used as the reference for further configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ConfluenceReleaseNotesPublisher'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • jiraCredentialsID
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  These jira credentials and project will be used to operate on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • confluenceCredentialsID
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This confluence together with the credentials will be used to publish the page.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spaceKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The key of the space on which the new page will be published
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • jqlFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A JQL filter used to select the tickets that will be shown on the newly created page. See the JIRA documentation for more information on how to use JQL.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pageTitle
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The title of the new page that will be published.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • parentPageTitle
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If specified the entire content tree of the space is searched for a page with this title. The new release notes page will be then published as a child page of this one.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ConsulBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • installationName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • operationList
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ConsulGetKV'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valuePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Consul path for the required value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      e.g. mysql/config/users/admin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • environmentVariableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Environment variable name for the value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ConsulServiceDiscoveryOperation'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • serviceName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Service name to look in consul
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • serviceTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Service tag - leave empty for no tag filtering.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • environmentVariableName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Environment variable name for the response.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Leave empty to use the same name of the service.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • healthStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Service health status.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • addPort
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add port number to response?
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The port will be added for every ip address - {ip}:{port}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'ConsulSetKV'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valuePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Consul path to set with your value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      e.g. mysql/config/users/admin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Value or ENV var name to use.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • consulSettingsProfileName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ConsulKVBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • hostUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Host URL should contain protocol (HTTP/HTTPS)://<HOST_NAME>.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Key is used in GET/PUT requests to lookup the value from, or right the key/value pair to the Consul key/value store.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • aclToken (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Token is used to supply UUID token for Consul ACL token calls. Token can be supplied by build parameters.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • apiUri (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  URL Override is used to override the K,V API URL.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • debugMode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable Debug messages for more verbose logging.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Values: ENABLED, DISABLED
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • envVarKey (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ENV Varaible Key is used to store the retrieved value in the build ENV variables to be used downstream.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ignoreGlobalSettings (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • keyValue (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Value is used in PUT calls to insert/update a key/value pair.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • requestMode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Request Mode set to READ will execute a GET to lookup the value, WRITE will execute a PUT to insert/update the value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Values: READ, WRITE, DELETE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • timeoutConnection (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Connection timeout in milliseconds, default is 10000.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • timeoutResponse (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response timeout in milliseconds, default is 30000.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • assessContainerImage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • failOnPluginError (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable this option to fail the build if the plugin encountered any errors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • imageId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Provide a Docker image ID or name which can be referenced by the Docker daemon (e.g. my-repo/my-image:my-tag).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • nameRules (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • packageName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • contains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the name that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • vulnerabilityCategory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • contains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the name that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • vulnerabilityTitle
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • contains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the name that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • vulnerablePackageName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • contains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the name that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • thresholdRules (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • criticalVulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • cvssV2Score
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • exploitableVulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • vulnerabilitiesWithMalwareKits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • moderateVulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • packageRiskScore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • riskScore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • severeVulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • totalVulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Select Fail to set the build status to Fail. Select Mark Unstable to set the build status to Unstable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the numeric threshold value that will trigger the selected action.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • treatWarningsAsErrors (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable this option to treat warnings as errors, which will fail the build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • workspaceDir (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • contentReplace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • configs (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • filePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A relative or absolute file path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • fileEncoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • configs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • replace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • matchCount
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ContinuousReleaseProperties'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: java.util.Map<java.lang.String, java.lang.String>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'CoordinatorBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add/Remove node, add/remove jobs, rename, check, right click to switch on Serial or Parallel pattern and have fun!
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • executionPlan
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: class org.jenkinsci.plugins.coordinator.model.TreeNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'CopadoBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • stepName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • webhookUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enter the Copado URL for the test that you want to run on this build step. The Copado URLs (webhooks) that are available for Copado can be found using this url http://docs.copa.do.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • api_key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enter your Copado API Key. A personal API Key is generated from the Account Summary tab in Copado. This makes it easy to use the API.

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the project to copy artifacts from.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Maven projects:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Matrix projects:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Multibranch Pipeline projects:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • excludes (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Specify paths or patterns of artifacts to exclude, even if specified in "Artifacts to copy". Can be blank.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • filter (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Relative paths to artifact(s) to copy or leave blank to copy all artifacts. This works just as a filter, and doesn't care whether all specified artifacts really exists. Check the /artifact/ browser of a build to see the relative paths to use here, as the build page typically hides intermediate directories. Can use wildcards like module/dist/**/*.zip, and use comma (followed by optional whitespace) to separate multiple entries. See the @includes of Ant fileset for the exact format. May also contain references to build parameters like $PARAM.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fingerprintArtifacts (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • flatten (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • optional (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • parameters (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • resultVariableSuffix (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The build number of the selected build will be recorded into the variable named COPYARTIFACT_BUILD_NUMBER_(SUFFIX) for later build steps to reference. You can specify that suffix part for that variable here.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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_
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selector (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  How to select the build to copy artifacts from, such as latest successful or stable build, or latest "keep forever" build. Other plugins may provide additional selections.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The build number of the selected build will be recorded in the environment for later build steps to reference. For details, see the help of "Result variable suffix" in "Advanced" section.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • downstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • upstreamProjectName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbstractProject based projects:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Freestyle projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Multi-configuration projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maven projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Non AbstractProject based projects:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pipeline jobs (aka. Workflow jobs)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • upstreamBuildNumber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • lastWithArtifacts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • lastCompleted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'MultiJobBuildSelector'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • buildParameter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • parameterName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • permalink
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'PromotedBuildSelector'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • level
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • latestSavedBuild
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • specific
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • buildNumber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • lastSuccessful
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • stable (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • upstream
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowUpstreamDependencies (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • fallbackToLastSuccessful (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • upstreamFilterStrategy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Values: UseGlobalSetting, UseOldest, UseNewest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • workspace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • target (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Target base directory for copy, or leave blank to use the workspace. Directory (and parent directories, if any) will be created if needed. May contain references to build parameters like $PARAM.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • copy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You can use the step copy files from master to current slaver.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • dstFile (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • keepMeta (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • recursive (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • srcFile (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: '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:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1. Use BuildMasters Jenkins Extensions 'Jenkins::Import-Artifact' statement to import artifacts directly from Jenkins: the post build action is required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. Use BuildMasters 'Create-Artifact' statement to import files from a folder that you've placed the artifacts into from the Jenkins build (eg using ArtifactDeployer Plugin): either the post build or build step actions will be fine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. Use an external artifact repository such as Nexus, Artifactory or ProGet: either the post build or build step actions will be fine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • applicationId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The identifier of the BuildMaster application to trigger the build for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Options are:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The BUILDMASTER_APPLICATION_ID variable populated by a previous step
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • An application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • releaseNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The BuildMaster release number to trigger the build for. Options are:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BUILDMASTER_RELEASE_NUMBER: variable populated by a previous step
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Latest Active Release: will automatically get the latest active release number from BuildMaster for the selected application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [Release Number]: a release number from the list of active releases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The job will fail if there is no active BuildMaster release.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • deployToFirstStage (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Will trigger the deployment to the first stage, and any subsequent stages where the stage is configured to automatically deploy to the next stage.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • waitUntilCompleted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If checked waits until BuildMaster has completed the deployment, otherwise will exits immediately after triggering the deployment to the first stage.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • printLogOnFailure (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • variables (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Provide a list of variables to pass to the build.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A variable must be in the format "variable=value"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Additional variables must be declared on separate lines
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lines starting with # are treated as comments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • When using pipeline script and you want to pass several variables use one of these formats:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Separate variables using newline character. Generated script will resemble: variables: 'var1=one\nvar2=two'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Separate variables using multi-line string. Generated script will resemble: variables: '''var1=one
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                var2=two'''
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • createCloudifyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Creates a topology from an environment blueprint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name} will be expanded, in runtime, to the value of a build parameter called app_name .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For explanation about the format of the outputs file, refer to the help tooltip for that parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • blueprintId (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Unique identifier for the created deployment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • credentialsId (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • debugOutput (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If checked, then printed Cloudify events and logs will include debug-level records.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • deploymentId (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Identifies the blueprint to create a deployment off.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • echoInputs (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If checked, then the Cloudify deployment inputs are echoed to the Jenkins log.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • echoOutputs (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            At the end of the build step, print the outputs and capabilities to the console.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • inputs (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file " parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • inputsFile (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs " parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • mapping (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This parameter must not be provided if "mapping file" is provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • mappingFile (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This parameter must not be provided if "mapping" is provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • outputFile (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "outputs": <outputs_dictionary>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "capabilities": <capabilities_dictionary>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • skipInstall (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Only create a Cloudify deployment; skip running the install workflow.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • tenant (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CreateFingerprint'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create Fingerprints of specified files during a build process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • targets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CreateRelease'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • prefix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the prefix of your project here. Example: P10 (P10 - Project number)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • itemPrefix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the prefix of your item here. Example: P1#I10 (P1 - Project number, I10 - Item number), P#I11, P#I12, P2#I13
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • releaseName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enter the name of the release here
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Add a line or two to describe the release
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mention the stage of the release
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • owner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mention the email id of the release’s owner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • period
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mention the number of days required for the release (not lesser than 3)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • createTag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • nexusInstanceId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • tagName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tag name is required and must be unique. Name can only contain letters, numbers, underscores, hyphens and dots and cannot start with an underscore or dot. The name cannot exceed 256 characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • tagAttributesJson (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional metadata for the tag in JSON format. These attributes will be merged with those contained in the attributes file if both are provided. Attributes in this field will override those present in the file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • tagAttributesPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The file path (environment-aware) to the optional metadata for the tag, using the workspace as the base path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CreateTemplate'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • cloud
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • workspace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The workspace in ElasticBox.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • instanceTags
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • templateName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • datacenter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • folder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • datastore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • claimFilter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • policyName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • claims
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'CriticalBlockEnd'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Release all resources that Critical block start had allocated for this job.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'CriticalBlockStart'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delimite the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'CucumberSlackBuildStepNotifier'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • channel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • json
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • hideSuccessfulResults
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'CustomPythonBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • home
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • nature
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ignoreExitCode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'CxScanBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This option is for users that may already have Jenkins credentials, as defined in Jenkins, and would like to use them with the CxSAST Jenkins plugin. Select your credentials from the drop-down list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NOTE: If your credentials do not exist in the system, you can add them by clicking Add and selecting Jenkins (see Adding Jenkins Credentials to the CxSAST Jenkins Plugin, for more information).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • buildStep
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • teamPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • sastEnabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • exclusionsSetting
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • failBuildOnNewResults
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enables the option to fail the build according to the defined severity (or higher). This option works in addition to the regular thresholds (e.g. if "x" total high vulnerabilities were found OR at least 1 new vulnerability, fail the build). This option is only available if the "Enable vulnerability threshold" parameter is enabled.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • failBuildOnNewSeverity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • useOwnServerCredentials (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • serverUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checkmarx server url or ip address with or without port. Syntax: http(s)://server-name:port. Example: http://checkmarx-server, https://10.0.0.255:9495
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • username (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Login username
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • password (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Login password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • isProxy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • configAsCode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • projectName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A full absolute name of a project. The full Project name includes the whole path to the project, including Server, service provider, company, and team. Example: "CxServer\SP\Company\Users\bs_java" If project with such a name doesn't exist in the system, new project will be created. May reference build parameters like ${PARAM}.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • projectId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • groupId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fully qualified team name for the project.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • preset (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Select the scan preset for this project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • jobStatusOnError (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determines how to act when a triggered Checkmarx scan in synchronous mode fails and returns an error message (i.e. no scan results, not to be confused with valid scan results that exceed the threshold).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FAILURE is equivalent to a Job error that fails the entire build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • UNSTABLE is equivalent to a Job warning that allows the build to proceed normally but provides an unstable status upon completion.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Use the global setting implies that this project uses the value either FAILURE or UNSTABLE defined globally by the CxSAST Jenkins plugin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Values: GLOBAL, FAILURE, UNSTABLE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • presetSpecified (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludeFolders (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Comma separated list of folders to exclude from scan. Entries in this list are automatically converted to exclude wildcard patterns and appended to the full pattern list provided in the advanced section. May reference build parameters like ${PARAM}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Conversion is done as follows:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fold1, fold2 fold3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                is converted to:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                !**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filterPattern (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example: **/*.java, **/*.html, !**\test\**\XYZ*

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pattern Syntax

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                There is a special case regarding the use of File.separators at the beginning of the pattern and the string to match:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When a pattern starts with a File.separator, the string to match must also start with a File.separator. When a pattern does not start with a File.separator, the string to match may not start with a File.separator. When one of these rules is not obeyed, the string will not match.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When a name path segment is matched against a pattern path segment, the following special characters can be used:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                '*' matches zero or more characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                '?' matches one character.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                May reference build parameters like ${PARAM}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Examples:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "**\*.class" matches all .class files/dirs in a directory tree.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "**" matches everything in a directory tree.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • incremental (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run incremental scan instead of full scan.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • fullScansScheduled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • fullScanCycle (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Incremental scans are faster, but with time they become less accurate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Therefore, after a number of incremental scans it is recommended to perform a full scan.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Here you can schedule periodic full scans to be executed after a certain number of incremental scans.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Alternatively, if you want to run full scans on weekends, you can create 2 separate jobs.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                First job - to run incremental scans on weekdays and second job - to run full scans on weekends.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • sourceEncoding (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Source code character encoding.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • comment (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Free text comment. May reference build parameters like ${PARAM}.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • skipSCMTriggers (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Do not perform Checkmarx scan when the build was triggered by SCM Change.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • waitForResultsEnabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                In synchronous mode, Checkmarx build step will wait for Checkmarx scan to complete, then retrieve scan results and optionally check vulnerability thresholds. When disabled, the build step finishes after scan job submissions to Checkmarx server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • vulnerabilityThresholdEnabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Mark the build as unstable if the number of high severity vulnerabilities is above the specified threshold.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • highThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                High severity vulnerability threshold. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mediumThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Medium severity vulnerability threshold. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lowThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Low severity vulnerability threshold. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaHighThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                High severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaMediumThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Medium severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaLowThreshold (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Low severity vulnerabilities threshold for dependency scan. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • generatePdfReport (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Downloads a PDF report with scan results from the Checkmarx server. The report is available via a link on "Checkmarx Scan Results" page.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • enableProjectPolicyEnforcement (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Mark the build as failed or unstable if the project's policy is violated.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Assigning a policy to a project is done from within CxSAST
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • thresholdSettings (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • vulnerabilityThresholdResult (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • avoidDuplicateProjectScans (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If there is a scan of this project in the queue in status working or queued do not send a new scan request to Checkmarx
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • addGlobalCommenToBuildCommet (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Allow sast comment to be added to the build comment.By default the global comment is empty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • generateXmlReport (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Generate full XML and HTML CxSAST scan reports. These reports will contain additional information about the detected vulnerabilities
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • dependencyScanConfig (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • dependencyScanExcludeFolders (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • dependencyScanPatterns (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • dependencyScannerType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Values: OSA, SCA
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fsaVariables (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • osaArchiveIncludePatterns (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • osaInstallBeforeScan (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • overrideGlobalConfig (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scaAccessControlUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scaCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scaServerUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scaTenant (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scaWebAppUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludeOpenSourceFolders (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includeOpenSourceFolders (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaArchiveIncludePatterns (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Comma separated list of archive wildcard patterns to include their extracted content for the scan. eg. *.zip, *.jar, *.ear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Supported archive types are: jar, war, ear, sca, gem, whl, egg, tar, tar.gz, tgz, zip, rar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Leave empty to extract all archives
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaEnabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • osaInstallBeforeScan (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Select this option in order to be able to scan packages from various dependency managers (NPM, Nugget, Python and more.) as part of the CxOSA scan
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • thisBuildIncremental (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DASTScan
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • apikey (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Your API key can be found on the Breachlock Platform under

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Organization settings > Integrations > Jenkins

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • asset (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Select the asset that will be scanned on build.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If the asset you are looking for is missing:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • email (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The email-address you registered on Breachlock Platform.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • osfBuilderSuiteForSFCCDataImport
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • hostname (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • tfCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ocCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ocVersion (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • archiveName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • sourcePath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includePatterns (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • includePattern
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • excludePatterns (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • excludePattern
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • importStrategy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • tempDirectory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'DaticalDBBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • daticalDBProjectDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The Datical DB Project Directory is the path location of your Datical DB Project folder. This will contain a datical.project file.

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This should be a fully qualified file path such as C:\DaticalDB\repl\hammer.bat or /opt/DaticalDB/repl/hammer.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • daticalDBExportSQL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When checked for Deploy and Forecast actions, Datical DB will export SQL to be run against the target server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • daticalDBExportRollbackSQL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When checked for Deploy and Forecast actions, Datical DB will export Rollback SQL to be run against the target server. When checked for Rollback, will only export SQL and NOT perform a Rollback.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • daticalDBScriptDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The Datical DB Script Directory is the fully qualified location of the Datical DB Scripts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This should be a fully qualified file path such as file:/C:\DaticalDB\repl\scripts or /opt/DaticalDB/repl/scripts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DebianPackageBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pathToDebian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • nextVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • generateChangelog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Warning: multiple SCM Locations should not be checked out to single directory.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • signPackage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildEvenWhenThereAreNoChanges
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check this if you want automated builds (timer- and SCM-triggered) to carry on even if there were no changes in the built package.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • debianPbuilder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • additionalBuildResults (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set this variable in order to get the files back from the chroot build environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The files that are retrieved will also automatically be archived as well with the other build results.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This must be a comma-separated list; spaces are allowed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • architecture (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The architecture to build this as.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This is mostly to support Pipeline, however it can be used as a normal parameter as well.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • buildAsTag (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • components (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The setting guessComponents must be false for this setting to be honored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • debianDirLocation (optional)

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This may also be set globally

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • distribution (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • guessComponents (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • keyring (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • mirrorSite (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • numberCores (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pristineTarName (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • dotnetNuGetDelete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The dotnet nuget delete command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • apiKeyId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The API key for the server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • forceEnglishOutput (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Forces the application to run using an invariant, English-based culture.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • noServiceEndpoint (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Doesn't append "api/v2/package" to the source URL.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Available since: .NET Core SDK 2.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • packageName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name/ID of the package to delete.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • packageVersion (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Version of the package to delete.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • sdk (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of a .NET SDK to use so that dotnet will be in the path.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If the default is specified, you either need to use the With .NET element (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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • showSdkInfo (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If enabled, 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • source (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Specifies the server URL. Supported URLs for nuget.org include 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).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • specificSdkVersion (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Depending on the platform, the 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        By enabling this option, the configured SDK home directory will be checked, and if it only includes a single SDK deployment, a global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Note: This will silently overwrite any global.json already present in the current directory.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workDirectory (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The directory in which to execute the command. By default, this is the current directory (for freestyle jobs, that is the root of the job's workspace).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DeleteApplication'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the a server from the list of servers configured in Jenkins Global Configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • appName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of the gear to be deleted.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the user domain containing the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • deleteCloudifyBlueprint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use this step to delete a Cloudify blueprint from Cloudify Manager.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • blueprintId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ID of blueprint to delete.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • tenant (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • deleteComponents
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • nexusInstanceId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • tagName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Components associated with this tag will be deleted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • deleteCloudifyEnv
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deletes a Cloudify environment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • credentialsId (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • debugOutput (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If checked, then printed Cloudify events and logs will include debug-level records.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • deleteBlueprintIfLast (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • deploymentId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ignoreFailure (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If checked, then failures during the removal of the environment will be ignored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • skipUninstall (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Only delete the Cloudify deployment; skip running the uninstall workflow.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • tenant (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DeleteEnvironmentBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • systemId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • environmentName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DeleteVirtualizeBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverHost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • dependencyCheck
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • additionalArguments (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • odcInstallation (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • skipOnScmChange (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • skipOnUpstreamChange (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DeployApplication'

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • serverName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the a server from the list of servers configured in Jenkins Global Configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • appName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select a name for the application. If the application doesn't exist, it will be created before the deployment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cartridges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Specify a space delimited list of cartridges to be assigned to the application. e.g. jbosseap-6 mysql-5.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Note that the specified cartridges need to be available on the selected OpenShift server. For a complete list of available cartridges on OpenShift refer to OpenShift web console or use the command line too 'rhc cartridges'. Here is the list of some of the most common cartridges:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • jbossas-7
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • jbosseap-6
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodejs-0.10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • perl-5.10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • php-5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • php-5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • zend-6.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • python-2.6
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • python-2.7
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • python-3.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ruby-1.8
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ruby-1.9
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ruby-2.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • jbossews-1.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • jbossews-2.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 10gen-mms-agent-0.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mongodb-2.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mysql-5.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mysql-5.5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • phpmyadmin-4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • postgresql-8.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • postgresql-9.2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the user domain for the application. Note that the domain needs to be created before hand. The plugin will not create it if it doesn't exist.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • gearProfile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the gear profile to be used when creating the application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • deploymentPackage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The location of the deployment package can be specified as a directory path or a URL (e.g. to Nexus). The packages can be of type .WAR or .EAR in case of GIT deployment and .TAR.GZ archive for BINARY deployment. Examples:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • target/
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • http://www.myrepo.com/org/keycloak/keycloak-server/1.0.2.Final/keycloak-server-1.0.2.Final.war
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=central&g=org.keycloak&a=keycloak-server&v=1.0.2.Final&e=war

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        In case of URL or when only one deployment package exists in the given directory, the package is deployed under the root ("/") context. When multiple packages are found, all are deployed under their own context paths.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Token macro expressions can be used for specifying a URL:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        https://repo/nexus/service/local/artifact/maven/redirect?r=central&g=${ENV,var="GROUPID"}&a=${ENV,var="ARTIFACTID"}&v=${ENV, var="VERSION"}&e=war

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check Token Macro Plugin for further details.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • environmentVariables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • autoScale
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • deploymentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type of deployment the application accepts ('git' or 'binary')
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Values: GIT, BINARY
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • openshiftDirectory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The .openshift directory is a directory where a user can create action hooks, set markers, and create cron jobs. Check OpenShift User Guide for further details.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'DeployBox'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cloud
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • workspace
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The workspace in ElasticBox to look for box to launch.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • box
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The box in the selected workspace to launch.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boxVersion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The version of the selected box. If Latest is selected then the version will be the box itself or the last version depending on how the box is shared in the selected workspace.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • instanceName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • profile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • claims
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • instanceEnvVariable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Define an environment variable for the instance deployed by this build step. The variable will hold the instance ID.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Additional instance properties will also be available via other environment variables that have the defined variable as prefix of their name. For example, if INSTANCE is specified for this field then the following environment variables are available:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE - ID of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_URL - URL of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_SERVICE_ID - service ID of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_TAGS - comma-separate list of tags of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If 1 is specified for Number of Instances then the following environment variables are available:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_MACHINE_NAME - VM name of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_PUBLIC_ADDRESS - VM public address of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_PRIVATE_ADDRESS - VM private address of the deployed instance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If Number of Instances is greater than 1, the following environment variable are available:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_MACHINE_NAMES - space-separate list of VM names
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_PUBLIC_ADDRESSES - space-separate list of public addresses of the VMs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          INSTANCE_PRIVATE_ADDRESSES - space-separate list of private addresses of the VMs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • tags
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Comma-separate tags to be added to the instance. These tags will be used to look up for the instance to determine whether the instance already exists. Build parameters or environment variables can be specified in tag with the format ${VARIABLE_NAME}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • variables
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • expiration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select whether the deployed instance will be expired via termination or shutdown in a specific number of hours from now or at a specific date and time in the future.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • $class: 'AlwaysOn'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'ShutDown'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • hours
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Date in format MM/dd/yyyy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Time in format HH:mm with hour from 00 to 23
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'Terminate'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • hours
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Date in format MM/dd/yyyy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Time in format HH:mm with hour from 00 to 23
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • autoUpdates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • alternateAction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • waitForCompletion
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • waitForCompletionTimeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Timeout in minutes to wait for this Deploy Box build step to complete. This field is ignored if Wait for completion is unchecked.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boxDeploymentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • samDeploy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • region
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • s3Bucket
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the S3 bucket where this command uploads the artifacts that are referenced in your template.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            S3 bucket will be created automatically if it does not exist.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • stackName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the AWS SAM stack you're deploying to. If you specify an existing stack, the command updates the stack. If you specify a new stack, the command creates it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • templateFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The path, relative to the workspace directory, where your AWS SAM template is located.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Examples:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            template.yaml
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            app/template.json
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • kmsKeyId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The ID of an AWS KMS key that the command uses to encrypt artifacts that are at rest in the S3 bucket. If not specified, SSE-AES256 is used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • outputTemplateFile (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The path to the file (relative to the workspace directory) where the build step writes the output AWS SAM template.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            template-#jobId.yaml by default.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • parameters (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A list of key-value pairs that specify input parameters for the change set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • roleArn (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS SAM assumes when executing the change set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • s3Prefix (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A prefix name that the command adds to the artifacts' name when it uploads them to the S3 bucket. The prefix name is a path name (folder name) for the S3 bucket.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • tags (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A list of tags to associate with the stack that is created or updated. AWS SAM also propagates these tags to resources in the stack.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • crxDeploy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deploy CRX Content Package files from the workspace to a configured Adobe Granite repository via the CRX Package Manager.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Only package files with .zip or .jar extensions will be identified and deployed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • packageIdFilters (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Specify a list of package ID filters and path filters to match against identified Vault packages located in the workspace. Each filter string must occupy its own line.

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, this pattern will match all zip files under the Local Directory:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  **/*.zip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Packages/acme-*.zip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Matching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http://deployer@localhost:4502

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http://deployer:Password123@localhost:4502

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This field supports parameter tokens.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • acHandling (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Change the way content ACL's included in the package filter scope are handled during installation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defer to Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Allow package to specify AC Handling mode. (This can be dangerous. Consider using a Validate CRX Content Packages step to check packages for destructive AC Handling rules before you deploy them.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ignores the packaged access control and leaves the target unchanged.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MergePreserve
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Merge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Overwrite
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Applies the access control provided with the package to the target. This also removes existing access control.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clears all access control on the target system.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • autosave (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Specify the number of changes to batch before saving the JCR session during package installation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • behavior (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Specify the behavior when a package exists on the target server that has the same package ID as one you are trying to deploy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Select the login credentials with which content packages will be deployed to the CRX server.

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

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

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deploys (or re-deploys) a build to a particular stage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Note: that when used in a pipeline step that the applicationId, releaseNumber, and buildNumber fields are required:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        buildMasterDeployBuildToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, buildNumber: BUILDMASTER_BUILD_NUMBER)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • applicationId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The identifier of the BuildMaster application to trigger the build for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Options are:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • The BUILDMASTER_APPLICATION_ID variable populated by a previous step
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • An application id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • An application name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • releaseNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The BuildMaster release number to trigger the build for. Options are:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • BUILDMASTER_RELEASE_NUMBER: variable populated by a previous step
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Latest Active Release: will automatically get the latest active release number from BuildMaster for the selected application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [Release Number]: a release number from the list of active releases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The job will fail if there is no active BuildMaster release.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • buildNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The BuildMaster build number to trigger the deployment for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The must be set to an existing build number. Typically this would be obtained from the output of the createBuild step which populates the BUILDMASTER_BUILD_NUMBER environment variable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • force (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Force deployment into the stage, even if a previous stage has failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • printLogOnFailure (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stage (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional. If not supplied, the next stage in the pipeline will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • variables (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set deployment level variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • waitUntilCompleted (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If checked waits until BuildMaster has completed the deployment, otherwise will exits immediately after triggering the deployment. Defaults to checked.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'Deployer'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stack
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The GitHub repository where the stack is stored, in the form <owner>/<name> (no spaces!).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether to deploy in dry-run mode.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • branch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The repository branch to deploy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiKey
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The Stack Hammer API key, copied from the stack settings dialog in the Stack Hammer user interface.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • addDeployToDashboard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • env
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • buildNumber
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DeploymentBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the Convertigo server url here. COnvertigo server url is in this form
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http://<server>:<port>/convertigo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • userId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the Convertigo server administration console userid here..
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the Convertigo server administration console password here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enableZipFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enableAutoDeploy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enableTestCase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • testcaseblock
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • projectname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Select in this list here a project name you want to test. This list is retrieved from the target Convertigo server each time you add a new Test block.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • testcasename
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Select in this list here a test case you want to run.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • xpath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              By clicking the Execute Testcase button you will have the data resulting from a testcase. Reading this data you will be able to enter assertions in this text box your assertions. Supported Syntax is :
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • assert ok
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expression1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expression2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expressionn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • assert nok
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expression1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expression2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                xpath expressionn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              All Xpath expressions below assert ok must match to have this test to be a success.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              One Xpath expressions below assert nok must match to have this test to be a failure.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              You can test you assertions by clicking the Validate XPath button. The test result will display beneath this text box.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DescribeWithParamsBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • starter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Do you want to show the name of the starter?
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • separator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Line end separator for your "Markup Formatter" setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          For example, "" for "Plain text", and "<br>" for "Safe HTML".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • excludes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The parameters that you want to hide, separated by ";".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DescriptionSetterBuilder'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This plugin automatically sets a description for the build as a step during building.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • regexp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If configured, the regular expression will be applied to each line in the build log. A description will be set based on the first match.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          To select the version of a Maven release, you can use this regular expression:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \[INFO\] Uploading project information for [^\s]* ([^\s]*)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The description to set on the build.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • If a regular expression is configured, every instance of \n will be replaced with the n-th group of the regular expression match.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • If the description is empty, the first group selected by the regular expression will be used as description.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • If no regular expression is configured, the description is taken verbatim.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • devSpacesCreate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • azureCredentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • aksName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • kubeconfigId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • resourceGroupName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • sharedSpaceName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of the parent dev space of the current dev space.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • spaceName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • svDeployTest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deploys and starts CA DevTest test or test suite provided as a .mar file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useCustomRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true to override the default global connection setting to CA DevTest registry for the particular project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The correct hostname or registry name needs to be entered
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • marFilePath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Path to MAR file that will be uploaded to the VSE. Needs to be relative path to MAR file in job workspace.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • testType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Choose whether mar file contains test or test suite.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • tokenCredentialId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • secured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true if the CA DevTest API are set to accept only https connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • svDeployVirtualService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Deploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useCustomRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true to override the default global connection setting to CA DevTest registry for the particular project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The correct hostname or registry name needs to be entered
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vseName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the name of the VSE to which you want this build step to apply
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • marFilesPaths
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Path to MAR file that will be uploaded to the VSE. The field supports multiple strings delimited by a separate line or comma.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Possibilities:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          for files in job workspace you can specify:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • relative path to MAR file in job workspace (example: dir/test.mar)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • path to MAR files using ant glob syntax (example: **/*.mar)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          for files on the DevTest machine you can specify:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • absolute path to file (example: file:///C:/something/test.mar)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • http location of MAR file (example: http://something/test.mar)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • tokenCredentialId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • secured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true if the CA DevTest API are set to accept only https connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • svStartVirtualService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Starts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useCustomRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true to override the default global connection setting to CA DevTest registry for the particular project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The correct hostname or registry name needs to be entered
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vseName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the name of the VSE to which you want this build step to apply
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vsNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • tokenCredentialId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • secured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true if the CA DevTest API are set to accept only https connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • svStopVirtualService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useCustomRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true to override the default global connection setting to CA DevTest registry for the particular project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The correct hostname or registry name needs to be entered
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vseName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the name of the VSE to which you want this build step to apply
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vsNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • tokenCredentialId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • secured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true if the CA DevTest API are set to accept only https connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • svUndeployVirtualService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Undeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • useCustomRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true to override the default global connection setting to CA DevTest registry for the particular project
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The correct hostname or registry name needs to be entered
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vseName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the name of the VSE to which you want this build step to apply
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • vsNames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • tokenCredentialId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • secured
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set to true if the CA DevTest API are set to accept only https connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • importDeveloperProfile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • importIntoExistingKeychain (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • keychainId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • keychainName (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • keychainPath (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • keychainPwd (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: class hudson.util.Secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • profileId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DiawiUploader'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • fileName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • proxyHost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • proxyPort
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • proxyProtocol
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • dingtalk
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • robot
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • at (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • atAll (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • btnLayout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Values: H, V
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • btns (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • title
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • actionUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • hideAvatar (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • messageUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • picUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • singleTitle (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • singleUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • text (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: Array / List of String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • title (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • type (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Values: 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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • distDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • libLocations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Array / List of Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • libDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • testDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This specifies a relative path in the project workspace where compiled tests resides. For example if tests are in build/test/classes then type "build/test/classes". In case you check "Compile tests" checkbox this relative path will be used for storing compiled tests classes which were before check-out from a repository.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • waitForNodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • compileTests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DockerBuilderControl'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • option
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderControlOptionProvisionAndStart'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cloudName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • templateId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderControlOptionRun'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cloudName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • image
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pullCredentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • dnsString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • dockerCommand
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • volumesString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • volumesFrom
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • environmentsString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • extraGroupsString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • memoryLimit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • memorySwap
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cpuPeriod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cpuQuota
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cpuShares
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • shmSize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bindPorts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bindAllPorts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • privileged
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • tty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • macAddress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderControlOptionStart'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cloudName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • containerId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderControlOptionStop'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cloudName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • containerId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • remove
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderControlOptionStopAll'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • remove
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'DockerBuilderNewTemplate'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Adds specified image configuration to all Docker Clouds.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • dockerTemplate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • dockerTemplateBase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • $class: 'DockerTemplateBase'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • image
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The hash or tagged name of the image that you wish docker to run (e.g "docker run -i -t <id> /bin/bash")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • bindAllPorts (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • bindPorts (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Bind ports from inside the container to outside of the host, scheme is hostport:containerport. Same effect as the "-p" or "-P" option on the CLI. Docker documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • capabilitiesToAddString (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of new line separated capabilities.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Each line represents an option for the --cap-add parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • capabilitiesToDropString (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of new line separated capabilities.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Each line represents an option for the --cap-drop parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • cpuPeriod (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the period of CPUs to limit the container’s CPU usage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The default CPU CFS (Completely Fair Scheduler) period is 100000us.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Consult Docker Run Documentation for further information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • cpuQuota (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limits the container’s CPU usage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The default 0 value allows the container to take 100% of a CPU resource.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Consult Docker Run Documentation for further information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: long
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • cpuShares (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Similarly the operator can increase the priority of this container. By default (no value), all containers run at the same priority and get the same proportion of CPU cycles, but you can tell the kernel to give more shares of CPU time to one or more containers when you start them via Docker.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Consult Docker Run Documentation for further information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • devicesString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                New line separated list of devices to be mapped (e.g: /dev/fuse). The full scheme is origin:destination:permissions, although just specifying the origin is enough. Docker documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • dnsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the DNS servers to use within your images, if not set Docker will use DNS settings of the host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • dockerCommand (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The command to run for this image. Be aware setting this might have impacts on the Launch mechanism, for sample SSH Launcher do configure sshd with injected keys authentication, overriding this command might prevent the agent to start.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whatever it does, this command must keep the container running, so Jenkins can establish a remote connection at any time. If not set, Jenkins will configure a general purpose command to just wait for stdin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If you need your image to start some additional services, you should consider using an Entrypoint, and follow best practices so that the command is eventually executed by your entrypoint script.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • environmentsString (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note that quotes are not interpreted.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                e.g. foo="bar" will result in the quotes being part of foo's value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                e.g. The single setting:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                can be (accidentally) turned into three separate settings:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                thus preventing the configuration from working as was intended.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • extraDockerLabelsString (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of new line separated docker labels to be set on the container, Specified in the form "label_name=value".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This has no effect on Jenkins functionality, and is not related to the labels used by Jenkins to map jobs to agent nodes. These labels are metadata attached to the docker container itself (again, not the jenkins agent), and which can typically be read using the docker inspect command.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This can be useful when using a docker cluster (like docker swarm) to pass information to the scheduler, in conjunction with constraints; or to let other services (portainer, prometheus...) know how they should categorize or otherwise deal with this specific container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Notes:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spaces are the beginning and end of the label name and value will be removed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • invalid lines will be ignored
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • extraGroupsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run a container with the specified additional groups (e.g. "docker run --group-add ...").
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Refer to the docker run command reference for the correct syntax.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • extraHostsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of new line separated hostnames/IP mappings to be added to the container’s /etc/hosts file. Specified in the form "hostname:IP".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • hostname (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • macAddress (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Container MAC address (e.g. 92:d0:c6:0a:29:33)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • memoryLimit (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • memorySwap (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The operator can constrain the swap memory available to a container. This value is the total memory available to the container (swap + memory). To disable swap limit, you can set it to "-1".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Consult Docker Run Documentation for further information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • network (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • privileged (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • pullCredentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • securityOptsString (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of new line separated security options.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Each line represents an option for the --security-opt parameter sent to the docker server. The options are in the format key=value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Please check https://docs.docker.com/engine/reference/run/#security-configuration for further information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • shmSize (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Size of /dev/shm in MB. If you omit the size entirely (or use the value 0), the system uses 64 MB.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Consult Docker Run Documentation for further information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • tty (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • user (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run a container with the specified user (e.g. "docker run --user ...").
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Refer to the docker run command reference for the correct syntax. Note that you have to specify a numeric uid if you want to run a container as a user, which exists on the host machine but does not exist within the container.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • volumesFromString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                New line separated list of volumes to inherit from another container. Specified in the form <container name>[:<ro|rw>]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If accessmode not specified, then default rw will be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • volumesString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                New line separated list of host volume mounts : <host/path>[<container/path>[<:mode>]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • container/path create empty volume container/path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host/path:container/path will mount host/path from host to container's container/path, read/write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host/path:container/path:rw will mount host/path from host to container's container/path, read/write
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host/path:container/path:ro will mount host/path from host to container's container/path, read-only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note: if access mode not specified, then default rw will be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Attach Docker container
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This method runs a container, then connects to it using docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Connect with JNLP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The container will only be passed an initial docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Connect with SSH
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The specified image is expected to run an SSH server. Then, it will treat that computer like it usually does for any SSH connected agent: the master will log into it, copy the remoting agent, then start it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • attach
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • entryPointCmdString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • javaExe (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • jvmArgsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • user (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                User that the Jenkins agent code will run as.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The container's default user (typically "root") will be used if this is left blank.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • jnlp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • jnlpLauncher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • jnlp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • vmargs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If the agent JVM should be launched with additional VM arguments, such as "-Xmx256m", specify those here. List of all the options are available here.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • webSocket (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Use WebSocket to connect to the Jenkins master rather than the TCP port. See JEP-222 for background.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • workDirSettings (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Allows disabling Remoting Work Directory for the agent. In such case the agent will be running in the legacy mode without logging enabled by default.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • workDirPath
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If defined, a custom Remoting work directory will be used instead of the Agent Root Directory. This option has no environment variable resolution so far, it is recommended to use only absolute paths.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • internalDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Defines a storage directory for the internal data. This directory will be created within the Remoting working directory.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • failIfWorkDirIsMissing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If defined, Remoting will fail at startup if the target work directory is missing. The option may be used to detect infrastructure issues like failed mount.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • entryPointArgumentsString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • jenkinsUrl (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If needed, the Jenkins URL can be overwritten with this property (e.g. to support other HTTP(S) endpoints due to reverse proxies or firewalling). By default the URL from the global Jenkins configuration is used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • user (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                User that the jenkins agent process will be run as. "root" if not specified.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ssh
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • sshKeyStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Define how a SSH key pair is configured for ssh authentication in container.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'InjectSSHKey'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Injected SSH key will let agent start as root in container. If you want to use another user configure it's name here. Please note such a user must pre-exist in container image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'ManuallyConfiguredSSHKey'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sshHostKeyVerificationStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • $class: 'KnownHostsFileKeyVerificationStrategy'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins master to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • $class: 'ManuallyProvidedKeyVerificationStrategy'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Checks the key provided by the remote host matches the key set by the user who configured this connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Type: 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)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • jvmOptions (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • launchTimeoutSeconds (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • maxNumRetries (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of times that attempts to connect to the newly-spun Docker container will be retried before the operation is abandoned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • port (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • prefixStartSlaveCmd (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • retryWaitTime (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of seconds to wait between attempts to connect to the newly-started Docker container.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • suffixStartSlaveCmd (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • labelString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Labels to give these nodes (for limiting your builds)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • instanceCapStr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The maximum number of containers, based on this template, that this provider is allowed to run in total. 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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • disabled (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • disabledByChoice (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enabledByChoice (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If not ticked then this functionality will be disabled.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This can be used to e.g. take a cloud or template out of action for maintenance etc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Values: NORMAL, EXCLUSIVE
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • name (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name prefix to use for all the Jenkins nodes created from this template.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Jenkins will append a unique ID to this name in order to create individual node names.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If blank or just whitespace, a default of "docker" will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • nodeProperties (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: ? extends hudson.slaves.NodeProperty<?>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • pullStrategy (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pull strategy during provisioning before image run.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Values: PULL_ALWAYS, PULL_LATEST, PULL_NEVER
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • pullTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Timeout, in seconds, to apply when expecting data from the Docker API when performing the docker pull operation. 0 means no time limit, but this is not recommended (if your docker API locks up, some aspects of Jenkins can also lock up).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                i.e. you probably want this set to as long as it takes to pull the entire image onto a fresh docker server. e.g. a few minutes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • remoteFs (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Root directory within your image for the Jenkins user to use
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • removeVolumes (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove the volumes associated to the container during container remove.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • retentionStrategy (optional)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Specify the strategy when docker containers shall be started and stopped:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Docker Once Retention Strategy (default)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                For each job in the queue, an own docker container is started. Once the job has finished, the container is shut down.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Docker Cloud Retention Strategy (experimental)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Based on the workload provided by the queue (load average), new docker containers are started on demand. After the job(s) have finished, the container is not shut down immediately. If no new job was executed on this agent/container during the period of the Idle delay, the container is shut down.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Keep this agent on-line as much as possible (experimental)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Starts as many containers as specified in the Instance Capacity (obeying the Container Cap) and tries to keep them always running (i.e. a new container is started in case another one belonging to this template was shut down).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Take this agent on-line according to a schedule (experimental)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Based on a cron-schedule agents are brought on-line and will keep running. Once the specified period in the schedule is over, the agents will be shut down.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Take this agent on-line when in demand and off-line when idle (experimental)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Containers are started if there are jobs waiting for execution in the queue. They are only started, if the jobs are waiting a certain threshold of time there (In demand delay). After the jobs have finished, the container is not shut down immediately. If no new job was executed on this agent/container during the period of the Idle delay, the container is shut down.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • idleMinutes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of minutes of idleness after which to kill the agent; serves a backup in case the strategy fails to detect the end of a task
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • stopTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Timeout, in seconds, to apply when stopping the container after a job has finished. The default of 10s is fine for most cases. However, if you container needs to do some cleanup after the agent has stopped you can increase the timeout. If the container fails to stop gracefully before the timeout ends, the container will be killed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerBuilderPublisher'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Build step that sends a Dockerfile for building to docker host that used for this build run.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • dockerFileDirectory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • fromRegistry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cloud
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cloud to do the build on - or, if empty, use the cloud that the build was performed on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • tagsString
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Repository name (and optionally a tag) to be applied to the resulting image in case of success.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Multiple entries are permitted if separated by newlines.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Environment variable substitution is performed on the strings so you can use e.g. ${BUILD_NUMBER} as part of each entry.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Each entry must be of the form IMAGE[:TAG] as per the docker tag command.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pushOnSuccess
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If enabled (and the docker image builds successfully), the resulting docker image will be pushed to the registry (or registries) specified within the "Image" field.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pushCredentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Credentials to push to a private registry.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cleanImages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cleanupWithJenkinsJobDelete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • noCache (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, builds the image with --no-cache which disables caching of layers. See the docker build command for more information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pull (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If set, builds the image with --pull to pull the latest version of the base image, instead of using the local one. See the docker build command for more information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $class: 'DockerComposeBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • useCustomDockerComposeFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • dockerComposeFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • option
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'ExecuteCommandInsideContainer'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • privilegedMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • command
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • workDir
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'StartAllServices'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StartService'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scale
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • $class: 'StopAllServices'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'StopService'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • $class: 'DockerPullImageBuilder'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • registry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • credentialsId
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • image
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Image ID on DockerHub. When set in combination with DockerHub trigger, a build will run when dockerhub builds a new image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • dockerShell
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • connector (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Choice of Objects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'CloudNameDockerConnector'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cloudName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • $class: 'DockerConnector'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • serverUrl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The URL to use to access your Docker server API (e.g: http://172.16.42.43:4243 or unix://).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • apiVersion (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Docker Daemon API version. Should be set when plugin underlying library can't connect to new daemon because docker daemon API become backward incompatible.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Version in format "1.22". Connector will append "/v${VERSION}" to api url for connector, where ${VERSION} is entered string. For details see docker_remote_api
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • connectTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Timeout for opening connection to Docker API. 0 is infinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Works only for Jersey.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • connectorType (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Docker-java provides different connection implementations based on different client libraries. In case you have some errors please try other.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Values: JERSEY, NETTY, OKHTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • credentialsId (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • readTimeout (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Read timeout to Docker API. In seconds. 0 is infinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • containerLifecycle (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • createContainer (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Nested Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • bindAllPorts (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • bindPorts (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Bind ports from inside the container to outside of the host, scheme is hostport:containerport. Same effect as the "-p" or "-P" option on the CLI. Docker documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • command (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The command to run for this image, replaced by Jenkins Launchers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cpuShares (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Similarly the operator can increase the priority of this container. By default (no value), all containers run at the same priority and get the same proportion of CPU cycles, but you can tell the kernel to give more shares of CPU time to one or more containers when you start them via Docker.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Consult https://docs.docker.com/engine/reference/run/#cpu-share-constraint for further information.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: int
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cpusetCpus (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cpusetMems (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type: String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • devicesString (optional)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add host device to container. For format please refer to