Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

createDeployerConfiguration

Back to index

Summary

Adds the deployer configuration to the deployer application.
projectName
Stringrequired
The name for the project that must be unique among all projects.
applicationName
Stringrequired
The name of the application.
stageName
Stringrequired
The name of the stage of a pipeline attached to a release if specified.
actualParameters
Mapoptional
Actual parameters.
applicationProjectName
Stringoptional
The name of the project containing specified application. If not specified, it is defaulted to the release project name.
deployerConfigurationName
Stringoptional
The name of deployer configuration. If not specified, a system generated GUID is used.
deployerTaskName
Stringoptional
The name of the deployer task defined in the provided stage.
environmentName
Stringoptional
The name of the environment.
environmentProjectName
Stringoptional
The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name.
environmentTemplateName
Stringoptional
The name of the environment template.
environmentTemplateProjectName
Stringoptional
The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name.
insertRollingDeployManualStep
Booleanoptional
True to indicate a manual step to inject after each phase or batch.
processName
Stringoptional
The name of the application process.
releaseName
Stringoptional
The name of the release.
rollingDeployEnabled
Booleanoptional
Perform rolling deployment.
rollingDeployManualStepAssignees
Collectionoptional
A list of assignees who receive the notification when rolling deploy iteration completes.
rollingDeployManualStepCondition
Stringoptional
Defines run condition on manual step created during rolling deployment.
Possible values: "always", "failure", "success"
rollingDeployPhases
Collectionoptional
One or more rolling deploy phases to be used for deployment.
rolloutApprovers
Collectionoptional
A list of rollout approvers.
rolloutNotificationEnabled
Booleanoptional
Rollout notification enabled (default is false).
skipDeploy
Booleanoptional
True to skip deployment to an environment.
snapshotName
Stringoptional
The name of the snapshot.

Usage

Perl

$cmdr->createDeployerConfiguration(
  "test-projectName", # projectName
  "test-applicationName", # applicationName
  "test-stageName" # stageName
  # optionals
);
▼

ectool

ectool createDeployerConfiguration \
  "test-projectName" `# projectName` \
  "test-applicationName" `# applicationName` \
  "test-stageName" `# stageName` \
  # optionals
▼

Examples

Perl

$cmdr->createDeployerConfiguration("Default", "Shopping Cart", "PROD", {releaseName => "Q1 Summary"});
▼

ectool

ectool createDeployerConfiguration "Default" "Shopping Cart" "PROD" --releaseName "Q1 Summary"
▼