retryTask

Back to index

Summary

Retries a pipeline task. This only applies to tasks that are waiting for a manual retry. It can be any pipeline task (excluding MANUAL, APPROVAL, GROUP, and DEPLOYER tasks) or an application deployment that is a part of a deployer task. For application deployments, a subapplication (and a subproject by Perforce) should be provided.
For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.
flowRuntimeId
UUIDrequired
The ID of the flow runtime.
stageName
Stringrequired
The name of the stage.
taskName
Stringrequired
The name of the task.
action
Stringoptional
Action to execute: rerun (default), skip or fail the task.
Possible values: "fail", "rerun", "skip"
comment
Stringoptional
Comment provided while retry an action on the manual process step or manual task or gate task.
gateType
Stringoptional
The type of the gate.
Possible values: "POST", "PRE"
subapplication
Stringoptional
The name of the sub application.
subproject
Stringoptional
The name of the project that contains the sub application.

Usage

Perl

$cmdr->retryTask( "test-flowRuntimeId", # flowRuntimeId "test-stageName", # stageName "test-taskName" # taskName # optionals );

ectool

ectool retryTask \ "test-flowRuntimeId" `# flowRuntimeId` \ "test-stageName" `# stageName` \ "test-taskName" `# taskName` \ # optionals

Examples

Perl

$cmdr->retryTask("4fa765dd-73f1-11e3-b67e-b0a420524153", "Final Deploy", "Confirm version", {comment => "Task to confirm version for final deployment"});

ectool

ectool retryTask 4fa765dd-73f1-11e3-b67e-b0a420524153 "Final Deploy" "Confirm version" --comment "Task to confirm version for final deployment"