Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

restartPipelineRun

Back to index

Summary

Restart a pipeline run.

Before restarting the pipeline run, update the task definition and fix issues causing the task to fail.

  • If the specified pipeline configures the disableRestart flag to true or 1, it cannot be restarted.

  • If the pipeline configures the disableMultipleActiveRuns flag to true or 1, only one active run of this pipeline is allowed at a time and attempts to restart it results in an exception. However, you are able to restart the current pipeline from a stage or task.

actualParameter
Arrayoptional
The list of actual parameters.
comment
Stringoptional
Comment provided while restarting pipeline run which has completed with error.
flowRuntimeId
UUIDoptional
The ID of the flow runtime.
flowRuntimeName
Stringoptional
The name of the flow runtime.
fromFailure
Booleanoptional
Used when taskName is a group. False to restart all subtasks or true to restart from failed subtask. Defaults to true.
gateType
Stringoptional
The type of the gate.
Possible values: "POST", "PRE"
projectName
Stringoptional
The name of the project.
stageName
Stringoptional
The name of a stage from which to restart a pipeline.
taskName
Stringoptional
The name of a high-level task in the last active stage from which to restart a pipeline.

Usage

Perl

$cmdr->restartPipelineRun(
  # optionals
);
▼

ectool

ectool restartPipelineRun \
  # optionals
▼

Examples

Perl

$cmdr->restartPipelineRun({comment => "Restarting pipeline..."});
▼

ectool

ectool restartPipelineRun --comment "Restarting pipeline..."
▼