modifyPipeline

Back to index

Summary

Modifies an existing pipeline.
projectName
Stringrequired
The name for the project that must be unique among all projects.
pipelineName
Stringrequired
The name of the pipeline.
assigneesForSkipStage
Arrayoptional
A list of users who can skip stages at runtime.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
disableMultipleActiveRuns
Booleanoptional
Boolean flag showing if option to run multiple pipelines simultaneously is disabled.
disableRestart
Booleanoptional
True to disable restart the pipeline.
enabled
Booleanoptional
True to enable the pipeline.
newName
Stringoptional
New name for an existing object that is being renamed.
overrideWorkspace
Booleanoptional
If true and workspaceName is not null, then all tasks use pipeline's workspace.
pipelineRunNameTemplate
Stringoptional
Template used to determine the default name for pipelines on startup.
releaseName
Stringoptional
The name of the release.
skipStageMode
Stringoptional
The flag to indicate if stages can be skipped at runtime.
Possible values: "DISABLED", "ENABLED", "RESTRICTED"
type
Stringoptional
Type of pipeline.
Possible values: "C", "R"
workspaceName
Stringoptional
The name of the default workspace for this pipeline.

Usage

Perl

$cmdr->modifyPipeline( "test-projectName", # projectName "test-pipelineName" # pipelineName # optionals );

ectool

ectool modifyPipeline \ "test-projectName" `# projectName` \ "test-pipelineName" `# pipelineName` \ # optionals

Examples

Perl

To change the pipeline name:

$cmdr->modifyPipeline("Default", "Web Site Deploy", {newName => "Web Site Update"});

ectool

To change the pipeline name:

ectool modifyPipeline "Default" "Web Site Deploy" --newName "Web Site Update"