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

Environment tier

3 minute readReference

addResourcesToEnvironmentTier

Adds resources to the specified environment tier.

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 add to the environment tier.

resourcePhaseMappings

Map

A map of resource and rolling deploy phase.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool addResourcesToEnvironmentTier projectName environmentName environmentTierName [optionals]
▼

createEnvironmentTier

Creates a new environment tier.

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.

batchSize

String

The size of the batch supported by the environment tier.

batchSizeType

BatchSizeType

The type of batch size supported by the environment tier.

description

String

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

resourceNames

Collection

List of resources to add to the environment tier.

resourcePhaseMappings

Map

A map of resource and rolling deploy phase.

resourcePoolNames

Collection

List of resource pools to add to the environment tier.

resourcePoolPhaseMappings

Map

A map of resource pool and rolling deploy phase.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool createEnvironmentTier projectName environmentName environmentTierName [optionals]
▼

deleteEnvironmentTier

Deletes an environment tier.

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.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

$cmdr->deleteEnvironmentTier(<projectName>, <environmentName>, <environmentTierName>);
▼

ectool

ectool deleteEnvironmentTier projectName environmentName environmentTierName
▼

getEnvironmentTier

Retrieves an environment tier by name.

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.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

$cmdr->getEnvironmentTier(<projectName>, <environmentName>, <environmentTierName>);
▼

ectool

ectool getEnvironmentTier projectName environmentName environmentTierName
▼

getEnvironmentTiers

Retrieves all environment tiers in an environment.

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.

Positional arguments

projectName, environmentName

Usage

ec-perl

$cmdr->getEnvironmentTiers(<projectName>, <environmentName>);
▼

ectool

ectool getEnvironmentTiers projectName environmentName
▼

modifyEnvironmentTier

Modifies an environment tier.

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.

batchSize

String

The size of the batch supported by the environment tier.

batchSizeType

BatchSizeType

The type of batch size supported by the environment tier.

description

String

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

newName

String

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

resourceNames

Collection

List of resources to add to the environment tier.

resourcePhaseMappings

Map

A map of resource and rolling deploy phase.

resourcePoolNames

Collection

List of resource pools to add to the environment tier.

resourcePoolPhaseMappings

Map

A map of resource pool and rolling deploy phase.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool modifyEnvironmentTier projectName environmentName environmentTierName [optionals]
▼

removeResourcesFromEnvironmentTier

Removes the given resources from the given environment tier.

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 remove from the environment tier.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool removeResourcesFromEnvironmentTier projectName environmentName environmentTierName [optionals]
▼
Environment
Gateway