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

Dynamic environment

12 minute readReference

addResourcePoolToEnvironmentTier

Adds a resource pool to a specific environment tier. A resource pool is a named group of resources.

Arguments

Argument Name Type Description

resourcePoolName

String

(Required) Name for the resource pool; must be unique among all resource pools.

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.

rollingDeployPhaseName

String

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

Positional arguments

resourcePoolName, projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool addResourcePoolToEnvironmentTier resourcePoolName projectName environmentName environmentTierName [optionals]
▼

addResourceTemplateToEnvironmentTemplateTier

Adds a resource template to the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

environmentTemplateTierName

String

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

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Positional arguments

projectName, environmentTemplateName, resourceTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->addResourceTemplateToEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
▼

ectool

ectool addResourceTemplateToEnvironmentTemplateTier projectName environmentTemplateName resourceTemplateName environmentTemplateTierName [optionals]
▼

addResourceToEnvironmentTemplateTier

Adds a resource to the specified environment template tier.

Arguments

Argument Name Type Description

resourceName

String

(Required) Name for the resource; must be unique among all resources.

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

resourceName, projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->addResourceToEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool addResourceToEnvironmentTemplateTier resourceName projectName environmentTemplateName environmentTemplateTierName
▼

createEnvironmentTemplate

Creates an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

description

String

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

Positional arguments

projectName, environmentTemplateName

Usage

ec-perl

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

ectool

ectool createEnvironmentTemplate projectName environmentTemplateName [optionals]
▼

createEnvironmentTemplateTier

Creates a tier in an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

description

String

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

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceNames

Collection

List of resources to add to the environment tier.

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->createEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>, {<optionals>});
▼

ectool

ectool createEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName [optionals]
▼

createEnvironmentTemplateTierMap

Creates an environment-template tier map for an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentTemplateName

String

(Required) The name of the environment template.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

tierMapName

String

The name of the environment template tier map. If not specified the operation will assume a hyphenated application and environment name.

tierMappings

Map

The list of mappings between the application tiers and the environment template tiers.

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Usage

ec-perl

$cmdr->createEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});
▼

ectool

ectool createEnvironmentTemplateTierMap projectName applicationName environmentProjectName environmentTemplateName [optionals]
▼

createHook

Creates a hook in a resource template, which can have one or more hooks. A hook stores a reference to a procedure in a CloudBees CD/RO project or plugin project. When a resource template is used to create a resource pool, these procedures are invoked.

Arguments

Argument Name Type Description

hookName

String

(Required) Name for the hook; must be unique among all hooks.

broadcast

Boolean

Broadcast flag.

description

String

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

hookParameters

Map

Hook parameters.

hookType

HookType

Hook type.

procedureName

String

Hook procedure name.

procedurePluginKey

String

Procedure plugin key.

procedureProjectName

String

Procedure project name.

projectName

String

ProjectName of the entity that owns the hook.

resourceTemplateName

String

Name of the resource template.

Positional arguments

hookName

Usage

ec-perl

$cmdr->createHook(<hookName>, {<optionals>});
▼

ectool

ectool createHook hookName [optionals]
▼

createResourceTemplate

Creates a resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

cfgMgrParameters

Map

Configuration manager plugin parameters.

cfgMgrPluginKey

String

Configuration manager plugin key.

cfgMgrProcedure

String

Configuration manager plugin method name.

cfgMgrProjectName

String

Configuration manager plugin project name.

cloudProviderParameters

Map

Cloud provider plugin parameters.

cloudProviderPluginKey

String

Cloud provider plugin key.

cloudProviderProcedure

String

Cloud provider plugin method name.

cloudProviderProjectName

String

Cloud provider plugin project name.

description

String

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

Positional arguments

projectName, resourceTemplateName

Usage

ec-perl

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

ectool

ectool createResourceTemplate projectName resourceTemplateName [optionals]
▼

deleteEnvironmentTemplate

Deletes an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

Positional arguments

projectName, environmentTemplateName

Usage

ec-perl

$cmdr->deleteEnvironmentTemplate(<projectName>, <environmentTemplateName>);
▼

ectool

ectool deleteEnvironmentTemplate projectName environmentTemplateName
▼

deleteEnvironmentTemplateTier

Deletes an environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->deleteEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool deleteEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName
▼

deleteEnvironmentTemplateTierMap

Deletes an environment template tier map from an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentTemplateName

String

(Required) The name of the environment template.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Usage

ec-perl

$cmdr->deleteEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});
▼

ectool

ectool deleteEnvironmentTemplateTierMap projectName applicationName environmentProjectName environmentTemplateName [optionals]
▼

deleteEnvironmentTemplateTierMapping

Deletes a tier mapping from an environment template tier map. A tier mapping is a mapping of an application tier to an environment template tier. A tier map has one or more mappings.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentTemplateName

String

(Required) The name of the environment template.

applicationTierName

String

(Required) The name of the application tier.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName, applicationTierName

Usage

ec-perl

$cmdr->deleteEnvironmentTemplateTierMapping(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, <applicationTierName>, {<optionals>});
▼

ectool

ectool deleteEnvironmentTemplateTierMapping projectName applicationName environmentProjectName environmentTemplateName applicationTierName [optionals]
▼

deleteHook

Deletes a hook associated with an entity.

Arguments

Argument Name Type Description

hookName

String

(Required) Name for the hook; must be unique among all hooks.

projectName

String

ProjectName of the entity that owns the hook.

resourceTemplateName

String

Name of the resource template.

Positional arguments

hookName

Usage

ec-perl

$cmdr->deleteHook(<hookName>, {<optionals>});
▼

ectool

ectool deleteHook hookName [optionals]
▼

deleteResourceTemplate

Deletes a resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

Positional arguments

projectName, resourceTemplateName

Usage

ec-perl

$cmdr->deleteResourceTemplate(<projectName>, <resourceTemplateName>);
▼

ectool

ectool deleteResourceTemplate projectName resourceTemplateName
▼

getAvailableResourcesForEnvironment

Retrieves all non-dynamic resources or resource pools.

Arguments

Argument Name Type Description

includePoolUsage

Boolean

Flag to determine whether or not include the pool usage.

objectTypeToReturn

String

Flag to determine whether to return resources or resource pools.

Positional arguments

None.

Usage

ec-perl

$cmdr->getAvailableResourcesForEnvironment({<optionals>});
▼

ectool

ectool getAvailableResourcesForEnvironment [optionals]
▼

getEnvironmentTemplate

Retrieves an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

Positional arguments

projectName, environmentTemplateName

Usage

ec-perl

$cmdr->getEnvironmentTemplate(<projectName>, <environmentTemplateName>);
▼

ectool

ectool getEnvironmentTemplate projectName environmentTemplateName
▼

getEnvironmentTemplates

Retrieves all environment templates in the specified project.

Arguments

Argument Name Type Description

projectName

String

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

Positional arguments

projectName

Usage

ec-perl

$cmdr->getEnvironmentTemplates(<projectName>);
▼

ectool

ectool getEnvironmentTemplates projectName
▼

getEnvironmentTemplateTier

Retrieves an environment tier in an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->getEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool getEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName
▼

getEnvironmentTemplateTierMaps

Retrieves all the environment template tier maps used by the specified application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

orderByEnvironmentTemplateUsage

Boolean

True to return most recently used environment template.

Positional arguments

projectName, applicationName

Usage

ec-perl

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

ectool

ectool getEnvironmentTemplateTierMaps projectName applicationName [optionals]
▼

getEnvironmentTemplateTiers

Retrieves all environment template tiers in the specified environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

includeTemplateDetails

Boolean

True to include resource template details.

Positional arguments

projectName, environmentTemplateName

Usage

ec-perl

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

ectool

ectool getEnvironmentTemplateTiers projectName environmentTemplateName [optionals]
▼

getHook

Retrieves a hook associated in an entity.

Arguments

Argument Name Type Description

hookName

String

(Required) Name for the hook; must be unique among all hooks.

projectName

String

ProjectName of the entity that owns the hook.

resourceTemplateName

String

Name of the resource template.

Positional arguments

hookName

Usage

ec-perl

$cmdr->getHook(<hookName>, {<optionals>});
▼

ectool

ectool getHook hookName [optionals]
▼

getHooks

Retrieves all hooks associated with an entity.

Arguments

Argument Name Type Description

projectName

String

ProjectName of the entity that owns the hook.

resourceTemplateName

String

Name of the resource template.

Positional arguments

None.

Usage

ec-perl

$cmdr->getHooks({<optionals>});
▼

ectool

ectool getHooks [optionals]
▼

getProvisionedEnvironments

Retrieves provisioned environments.

Arguments

Argument Name Type Description

flowRuntimeId

UUID

The ID of the flow runtime.

jobId

String

The primary key of the job, or the name of the job.

stageName

String

The name of the stage.

Positional arguments

None.

Usage

ec-perl

$cmdr->getProvisionedEnvironments({<optionals>});
▼

ectool

ectool getProvisionedEnvironments [optionals]
▼

getResourcePoolsInEnvironmentTier

Retrieves the list of resource pools in 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.

Positional arguments

projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool getResourcePoolsInEnvironmentTier projectName environmentName environmentTierName
▼

getResourcesInEnvironmentTemplateTier

Retrieves all resources in the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->getResourcesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool getResourcesInEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName
▼

getResourceTemplate

Retrieves the specified resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

Positional arguments

projectName, resourceTemplateName

Usage

ec-perl

$cmdr->getResourceTemplate(<projectName>, <resourceTemplateName>);
▼

ectool

ectool getResourceTemplate projectName resourceTemplateName
▼

getResourceTemplates

Retrieves all the resource templates.

Arguments

Argument Name Type Description

projectName

String

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

Positional arguments

projectName

Usage

ec-perl

$cmdr->getResourceTemplates(<projectName>);
▼

ectool

ectool getResourceTemplates projectName
▼

getResourceTemplatesInEnvironmentTemplateTier

Retrieves all resource templates in the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->getResourceTemplatesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool getResourceTemplatesInEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName
▼

modifyEnvironmentTemplate

Modifies an environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

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.

Positional arguments

projectName, environmentTemplateName

Usage

ec-perl

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

ectool

ectool modifyEnvironmentTemplate projectName environmentTemplateName [optionals]
▼

modifyEnvironmentTemplateTier

Modifies all environment template tiers in the specified environment template.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

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.

resourceCount

Integer

The number of resources to be spun from a given resource template.

resourceNames

Collection

List of resources to add to the environment tier.

resourceTemplateName

String

Name for the resource template; must be unique among all resource templates.

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->modifyEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>, {<optionals>});
▼

ectool

ectool modifyEnvironmentTemplateTier projectName environmentTemplateName environmentTemplateTierName [optionals]
▼

modifyEnvironmentTemplateTierMap

Modifies an existing environment template tier map.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

(Required) The name of the application.

environmentProjectName

String

(Required) The name of the environment’s project name.

environmentTemplateName

String

(Required) The name of the environment template.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

tierMapName

String

The name of the environment template tier map. If not specified the operation will assume a hyphenated application and environment name.

tierMappings

Map

The list of mappings between the application tiers and the environment template tiers.

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Usage

ec-perl

$cmdr->modifyEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});
▼

ectool

ectool modifyEnvironmentTemplateTierMap projectName applicationName environmentProjectName environmentTemplateName [optionals]
▼

modifyEnvTemplTierResourceTemplMapping

Modifies the resource count in an environment template tier.

Arguments

Argument Name Type Description

resourceCount

String

(Required) The number of resources to be spun from a given resource template.

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

environmentTemplateTierName

String

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

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Positional arguments

resourceCount, projectName, environmentTemplateName, resourceTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->modifyEnvTemplTierResourceTemplMapping(<resourceCount>, <projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
▼

ectool

ectool modifyEnvTemplTierResourceTemplMapping resourceCount projectName environmentTemplateName resourceTemplateName environmentTemplateTierName [optionals]
▼

modifyHook

Modifies an existing hook in a resource template.

Arguments

Argument Name Type Description

hookName

String

(Required) Name for the hook; must be unique among all hooks.

broadcast

Boolean

Broadcast flag.

description

String

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

hookParameters

Map

Hook parameters.

hookType

HookType

Hook type.

newName

String

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

procedureName

String

Hook procedure name.

procedurePluginKey

String

Procedure plugin key.

procedureProjectName

String

Procedure project name.

projectName

String

ProjectName of the entity that owns the hook.

resourceTemplateName

String

Name of the resource template.

Positional arguments

hookName

Usage

ec-perl

$cmdr->modifyHook(<hookName>, {<optionals>});
▼

ectool

ectool modifyHook hookName [optionals]
▼

modifyResourceTemplate

Modifies the specified resource template.

Arguments

Argument Name Type Description

projectName

String

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

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

cfgMgrParameters

Map

Configuration manager plugin parameters.

cfgMgrPluginKey

String

Configuration manager plugin key.

cfgMgrProcedure

String

Configuration manager plugin method name.

cfgMgrProjectName

String

Configuration manager plugin project name.

cloudProviderParameters

Map

Cloud provider plugin parameters.

cloudProviderPluginKey

String

Cloud provider plugin key.

cloudProviderProcedure

String

Cloud provider plugin method name.

cloudProviderProjectName

String

Cloud provider plugin project name.

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.

Positional arguments

projectName, resourceTemplateName

Usage

ec-perl

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

ectool

ectool modifyResourceTemplate projectName resourceTemplateName [optionals]
▼

provisionEnvironment

Provisions 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.

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateProjectName

String

Name for the project containing environment template.

keepOnError

Boolean

Tear down on error flag.

tierResourceCounts

Map

Resource count per environment template tier.

Positional arguments

projectName, environmentName, environmentTemplateName

Usage

ec-perl

$cmdr->provisionEnvironment(<projectName>, <environmentName>, <environmentTemplateName>, {<optionals>});
▼

ectool

ectool provisionEnvironment projectName environmentName environmentTemplateName [optionals]
▼

provisionResourcePool

Provisions a resource pool.

Arguments

Argument Name Type Description

resourceCount

String

(Required) Number of resources to provision.

resourcePoolName

String

(Required) Name for the resource pool.

projectName

String

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

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

keepOnError

Boolean

True to keep resource pool on error (default is false).

Positional arguments

resourceCount, resourcePoolName, projectName, resourceTemplateName

Usage

ec-perl

$cmdr->provisionResourcePool(<resourceCount>, <resourcePoolName>, <projectName>, <resourceTemplateName>, {<optionals>});
▼

ectool

ectool provisionResourcePool resourceCount resourcePoolName projectName resourceTemplateName [optionals]
▼

removeResourceFromEnvironmentTemplateTier

Removes a resource from an environment template tier.

Arguments

Argument Name Type Description

resourceName

String

(Required) Name for the resource; must be unique among all resources.

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

environmentTemplateTierName

String

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

Positional arguments

resourceName, projectName, environmentTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->removeResourceFromEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
▼

ectool

ectool removeResourceFromEnvironmentTemplateTier resourceName projectName environmentTemplateName environmentTemplateTierName
▼

removeResourcePoolFromEnvironmentTier

Removes a resource pool from the specified environment tier.

Arguments

Argument Name Type Description

resourcePoolName

String

(Required) Name for the resource pool; must be unique among all resource pools.

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

resourcePoolName, projectName, environmentName, environmentTierName

Usage

ec-perl

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

ectool

ectool removeResourcePoolFromEnvironmentTier resourcePoolName projectName environmentName environmentTierName
▼

removeResourceTemplateFromEnvironmentTemplateTier

Removes a resource template from the specified environment template tier.

Arguments

Argument Name Type Description

projectName

String

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

environmentTemplateName

String

(Required) The name of the environment template.

resourceTemplateName

String

(Required) Name for the resource template; must be unique among all resource templates.

environmentTemplateTierName

String

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

resourceTemplateProjectName

String

Name for the project to which the resource template belongs to.

Positional arguments

projectName, environmentTemplateName, resourceTemplateName, environmentTemplateTierName

Usage

ec-perl

$cmdr->removeResourceTemplateFromEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
▼

ectool

ectool removeResourceTemplateFromEnvironmentTemplateTier projectName environmentTemplateName resourceTemplateName environmentTemplateTierName [optionals]
▼
Directory provider
Email configuration