modifyRollingDeployPhase

Back to index

Summary

Modifies the rolling deploy phase associated with an environment.
projectName
Stringrequired
The name for the project that must be unique among all projects.
rollingDeployPhaseName
Stringrequired
The name of the rolling deploy phase.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
environmentName
Stringoptional
The name of the environment.
newName
Stringoptional
The new name for an existing object that is being renamed.
orderIndex
Integeroptional
Specifies the phase order (starts from 1).
phaseExpression
Stringoptional
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.
rollingDeployPhaseType
Stringoptional
The type of rolling deploy phase.
Possible values: "expression", "tagged", "untagged"

Usage

Perl

$cmdr->modifyRollingDeployPhase( "test-projectName", # projectName "test-rollingDeployPhaseName" # rollingDeployPhaseName # optionals );

ectool

ectool modifyRollingDeployPhase \ "test-projectName" `# projectName` \ "test-rollingDeployPhaseName" `# rollingDeployPhaseName` \ # optionals

Examples

Perl

$cmdr->modifyRollingDeployPhase('Default', 'Test Phase', {newName => 'QA Test Phase', orderIndex => 3});

ectool

ectool modifyRollingDeployPhase 'Default' 'Test Phase' --newName 'QA Test Phase' --orderIndex 3