API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Rolling deploy

3 minute readReference

createRollingDeployPhase

Adds a rolling deploy phase to the specified environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

rollingDeployPhaseName

String

(Required) The name of the rolling deploy phase.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

The name of the environment.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

String

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

RollingDeployPhaseType

The type of rolling deploy phase.

Positional arguments

projectName, rollingDeployPhaseName

Usage

ec-perl

$cmdr->createRollingDeployPhase(<projectName>, <rollingDeployPhaseName>, {<optionals>});
▼

ectool

ectool createRollingDeployPhase projectName rollingDeployPhaseName [optionals]
▼

deleteRollingDeployPhase

Deletes the rolling deploy phase associated with an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

rollingDeployPhaseName

String

(Required) The name of the rolling deploy phase.

environmentName

String

The name of the environment.

Positional arguments

projectName, rollingDeployPhaseName

Usage

ec-perl

$cmdr->deleteRollingDeployPhase(<projectName>, <rollingDeployPhaseName>, {<optionals>});
▼

ectool

ectool deleteRollingDeployPhase projectName rollingDeployPhaseName [optionals]
▼

getRollingDeployPhase

Retrieves the rolling deploy phase associated with an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

rollingDeployPhaseName

String

(Required) The name of the rolling deploy phase.

environmentName

String

The name of the environment.

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Positional arguments

projectName, rollingDeployPhaseName

Usage

ec-perl

$cmdr->getRollingDeployPhase(<projectName>, <rollingDeployPhaseName>, {<optionals>});
▼

ectool

ectool getRollingDeployPhase projectName rollingDeployPhaseName [optionals]
▼

getRollingDeployPhases

Retrieves all rolling deploy phases associated with an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

Name for the application.

applicationProjectName

String

Name for the application project.

environmentName

String

The name of the environment.

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getRollingDeployPhases(<projectName>, {<optionals>});
▼

ectool

ectool getRollingDeployPhases projectName [optionals]
▼

modifyRollingDeployPhase

Modifies the rolling deploy phase associated with an environment.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

rollingDeployPhaseName

String

(Required) The name of the rolling deploy phase.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentName

String

The name of the environment.

newName

String

The new name for an existing object that is being renamed.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

String

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

RollingDeployPhaseType

The type of rolling deploy phase.

Positional arguments

projectName, rollingDeployPhaseName

Usage

ec-perl

$cmdr->modifyRollingDeployPhase(<projectName>, <rollingDeployPhaseName>, {<optionals>});
▼

ectool

ectool modifyRollingDeployPhase projectName rollingDeployPhaseName [optionals]
▼

setTierResourcePhase

Maps a resource to a rolling deploy phase.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

environmentName

String

(Required) The name of the environment.

environmentTierName

String

(Required) Name for the environment tier; must be unique among all tiers for the environment.

resourceNames

Collection

List of resources to be mapped to a rolling deploy phase.

resourcePhaseMappings

Map

A map of resource and rolling deploy phase.

resourcePoolNames

Collection

List of resource pools to be mapped to a rolling deploy phase.

resourcePoolPhaseMappings

Map

A map of resource pool and rolling deploy phase.

rollingDeployPhaseName

String

Name for the rolling deploy phase to be associated with the resource.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

$cmdr->setTierResourcePhase(<projectName>, <environmentName>, <environmentTierName>, {<optionals>});
▼

ectool

ectool setTierResourcePhase projectName environmentName environmentTierName [optionals]
▼
Resource
Schedule