Edit

Share via

JenkinsQueueJob@1 - Jenkins Queue Job v1 task

  • Article

Use this task to queue a job on a Jenkins server.

Syntax

# Jenkins Queue Job v1
# Queue a job on a Jenkins server.
- task: JenkinsQueueJob@1
  inputs:
    serverEndpoint: # string. Required. Jenkins service endpoint. 
    jobName: # string. Required. Job name. 
    #isMultibranchJob: false # boolean. Job is of Multibranch Pipeline type. Default: false.
    #multibranchPipelineBranch: # string. Required when isMultibranchJob = true. Multibranch Pipeline Branch. 
    #captureConsole: true # boolean. Capture console output and wait for completion. Default: true.
    #capturePipeline: true # boolean. Optional. Use when captureConsole = true. Capture pipeline output and wait for pipeline completion. Default: true.
  # Advanced
    #parameterizedJob: false # boolean. Parameterized job. Default: false.
    #jobParameters: # string. Optional. Use when parameterizedJob = true. Job parameters.

Inputs

serverEndpoint - Jenkins service endpoint
string. Required.

Specifies the service endpoint for your Jenkins instance. Click the Manage link (when using the task assistant) to create a new Jenkins service endpoint.


jobName - Job name
string. Required.

The name of the Jenkins job to queue. This must exactly match the job name on the Jenkins server.


isMultibranchJob - Job is of Multibranch Pipeline type
boolean. Default value: false.

This job is a multibranch pipeline. If specified, add the appropriate branch name. This input requires Team Foundation Server Plugin for Jenkins v5.3.4 or later.


multibranchPipelineBranch - Multibranch Pipeline Branch
string. Required when isMultibranchJob = true.

Queues this multibranch pipeline job on the specified branch. This input requires Team Foundation Server Plugin for Jenkins v5.3.4 or later.


captureConsole - Capture console output and wait for completion
boolean. Default value: true.

If specified, this input captures the Jenkins build console output, waits for the Jenkins build to complete, and succeeds/fails based on the Jenkins build result. Otherwise, once the Jenkins job queues, this step successfully completes without waiting for the Jenkins build to run.


capturePipeline - Capture pipeline output and wait for pipeline completion
boolean. Optional. Use when captureConsole = true. Default value: true.

If specified, this input captures the full Jenkins build pipeline console output, waits for the full Jenkins build pipeline to complete, and succeeds/fails based on the Jenkins build pipeline result. Otherwise, once the first Jenkins job completes, this input successfully completes without waiting for the full Jenkins build pipeline to run.


parameterizedJob - Parameterized job
boolean. Default value: false.

Specifies if the Jenkins job accepts parameters. Use this input even if all default parameter values are used and no parameters are actually specified.


jobParameters - Job parameters
string. Optional. Use when parameterizedJob = true.

Specifies job parameters with one per line, for example: <parameterName>=<parameterValue>.

To set a parameter to an empty value, which is useful for overriding a default value, leave off the parameter value. For example, specify <parameterName>=.

Variables are supported. To set a commitId parameter value to the Git commit ID of the build, for example, you can use: commitId=$(Build.SourceVersion). For more information, see the documentation on variables.

The supported Jenkins parameter types are:

  • Boolean
  • Choice
  • Password
  • String

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version All supported agent versions.
Task category Build