addResourcePoolToEnvironmentTier
Adds a resource pool to a specific environment tier. A resource pool is a named group of resources.
You must specify the resourcePoolName
, projectName
, environmentName
, and environmentTierName
arguments.
Arguments | Descriptions |
---|---|
resourcePoolName |
Name of the resource pool that must be unique among all resource pools. Argument Type: String |
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentName |
Name of the environment that must be unique among all environments. Argument Type: String |
environmentTierName |
Name of the environment tier that must be unique among all tiers for the environment. Argument Type: String |
rollingDeployPhaseName |
(Optional) Name for the rolling deploy phase to be associated with the resource pool. Argument Type: String |
ec-perl
syntax: $<object>->addResourcePoolToEnvironmentTier(<resourcePoolName>, <projectName>, <environmentName>, <environmentTierName>, {<optionals>});
addResourceTemplateToEnvironmentTemplateTier
Adds a resource template to the specified environment template tier.
You must specify the resourceTemplateName
, projectName
, environmentTemplateName
, and environmentTemplateTierName
arguments.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
resourceTemplateName |
Name of the resource template that must be unique among all resource templates. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
resourceCount |
(Optional) Number of resources to be spun from the resource template. Argument Type: Integer |
resourceTemplateProjectName |
(Optional) Name of the project to which the resource template belongs. Argument Type: String |
Positional arguments
projectName, environmentTemplateName, resourceTemplateName , environmentTemplateTierName
ec-perl
syntax: $<object>->addResourceTemplateToEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
addResourceToEnvironmentTemplateTier
Adds a resource to the specified environment template tier.
You must specify the resourceName
, projectName
, environmentTemplateName
, and environmentTemplateTierName
arguments.
Arguments | Descriptions |
---|---|
resourceName |
Name of the resource that must be unique among all resources. Argument Type: String |
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name for the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
Positional arguments
resourceName, projectName, environmentTemplateName, environmentTemplateTierName
ec-perl
syntax: $<object>->addResourceToEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
createEnvironmentTemplate
Creates an environment template.
You must specify the projectName
and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by CloudBees CD . Argument type: String |
ec-perl
syntax: $<object>->createEnvironmentTemplate(<projectName>, <environmentTemplateName>, {<optionals>});
createEnvironmentTemplateTier
Creates a tier in an environment template.
You must specify the projectName
, environmentTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
resourceCount |
(Optional) The number of resources to be spun from a given resource template. Argument type: Integer |
resourceNames |
(Optional) List of resources to add to the environment tier. Argument type: Collection |
resourceTemplateName |
(Optional) Name for the resource template that must be unique among all resource templates. Argument type: String |
resourceTemplateProjectName |
(Optional) Name for the project to which the resource template belongs. Argument type: String |
ec-perl
syntax: $<object>->createEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>, {<optionals>});
createEnvironmentTemplateTierMap
Creates an environment-template tier map for an application.
You must specify the projectName
, applicationName
, environmentProjectName
, and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
applicationName |
Name of the application. Argument Type: String |
environmentProjectName |
Name for the project to which the environment belongs. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
applicationEntityRevisionId |
(Optional) Revision ID of the versioned object Argument Type: UUID |
tierMapName |
(Optional) Name of the tier map associated with the environment template. If you do not specify an tier map, CloudBees CD uses a tier map with a hyphenated-application-and-environment name. Argument type: String |
tierMappings |
(Optional) List of mappings between the application tiers and the environment template tiers. Argument Type: Map |
ec-perl
syntax: $<object>->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 project or plugin project. When a resource template is used to create a resource pool, these procedures are invoked.
You must specify the hookName
.
Arguments | Descriptions |
---|---|
hookName |
Name of the hook that must be unique among all hooks in the project. Argument Type: String |
broadcast |
(Optional) Broadcast flag Use this flag to broadcast the hook name in the project. The Argument type: Boolean |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
hookParameters |
(Optional) Parameters that are passed to the procedure. Argument type: Map |
hookType |
(Optional) Type of the hook:
Argument Type: String |
procedureName |
(Optional) Name of the procedure that the hook references. Argument Type: String |
procedurePluginKey |
(Optional) Name of the plugin procedure. Use this argument when the hook references a plugin procedure. The promoted version of the plugin is invoked by default. Argument Type: String |
procedureProjectName |
(Optional) Name of the project to which the procedure belongs. When you use a specific version of a plugin, this is the name of the plugin project. Argument Type: String |
projectName |
(Optional) Project name of the entity that owns the hook. Argument Type: String |
resourceTemplateName |
(Optional) Name of the resource template. Argument Type: String |
createResourceTemplate
Creates a resource template.
You must specify the projectName
and resourceTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
resourceTemplateName |
Name for the resource template that must be unique among all resource templates. Argument Type: String |
cfgMgrParameters |
(Optional) Configuration Manager plugin parameters that are passed from the configuration-manager plugin to CloudBees CD . Argument Type: Map |
cfgMgrPluginKey |
(Optional) Configuration Manager plugin key. Argument Type: String |
cfgMgrProcedure |
(Optional) Name of the cloud-provider plugin method. Argument Type: String |
cfgMgrProjectName |
(Optional) Name of the project to which the configuration-manager plugin applies. Argument Type: String |
cloudProviderParameters |
(Optional) Parameters that are passed from the cloud- provider plugin to CloudBees CD . Argument Type: Map |
cloudProviderPluginKey |
(Optional) Cloud-provider plugin key. Argument Type: String |
cloudProviderProcedure |
(Optional) Cloud-provider plugin method name. Argument Type: String |
cloudProviderConfig |
(Optional) Name of the cloud-provider plugin configuration. Argument Type: String |
cloudProviderProjectName |
(Optional) Name of the project to which the cloud-provider plugin applies. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
ec-perl
syntax: $<object>->createResourceTemplate(<projectName>, <resourceTemplateName>, {<optionals>});
deleteEnvironmentTemplate
Deletes an environment template.
You must specify the projectName
and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
deleteEnvironmentTemplateTier
Deletes an environment template tier.
You must specify the projectName
, environmentTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
ec-perl
syntax: $<object>->deleteEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
deleteEnvironmentTemplateTierMap
Deletes an environment template tier map from an application.
You must specify the projectName
, applicationName
, environmentProjectName
, and environmentTemplateName
arguments.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
applicationName |
Name of the application. Argument Type: String |
environmentProjectName |
Name for the project to which the environment template belongs. Argument Type: String |
environmentTemplateProjectName |
Name for the project to which the environment template belongs. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
ec-perl
syntax: $<object>->deleteEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName> <environmentTemplateName>);
deleteEnvironmentTemplateTierMapping
Deletes a tier mapping from a 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.
You must specify the projectName
, applicationName
, environmentProjectName
, environmentTemplateName
, and applicationTierName
arguments.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
applicationName |
Name of the application. Argument Type: String |
environmentProjectName |
Name for the project to which the environment belongs. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
applicationTierName |
Name of the application tier. Argument Type: String |
Positional arguments
projectName
, applicationName
, environmentProjectName
, environmentTemplateName
, applicationTierName
ec-perl
syntax: $<object>->deleteEnvironmentTemplateTierMapping(<projectName>, <applicationName>, <environmentProjectName> <environmentTemplateName> <applicationTierName>);
deleteHook
Deletes a hook associated with an entity.
You must specify the hookName
argument.
Arguments | Descriptions |
---|---|
hookName |
Name of the hook that must be unique among all hooks in the project. Argument Type: String |
projectName |
(Optional) Name of the project that owns the hook. Argument Type: String |
resourceTemplateName |
(Optional) Name of the resource template. Argument Type: String |
deleteResourceTemplate
Deletes a resource template.
You must specify the projectName
and resourceTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
resourceTemplateName |
Name for the resource template that must be unique among all resource templates. Argument Type: String |
getAvailableResourcesForEnvironment
Retrieves all non-dynamic resources or resource pools.
Arguments | Descriptions |
---|---|
includePoolUsage |
(Optional) < Boolean flag— If this is set to Argument Type: Boolean |
objectTypeToReturn |
(Optional) Flag to return resources or resource pools. Valid values are If this is set to Argument Type: String |
getEnvironmentTemplate
Retrieves an environment template.
You must specify the projectName
and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
Response
An environmentTemplate
element.
===ec-p erl
syntax: $<object>->getEnvironmentTemplate(<projectName>, <environmentTemplateName>);
getEnvironmentTemplateTier
Retrieves an environment tier in an environment template.
You must specify the projectName
, environmentTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
ec-perl
syntax: $<object>-getEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
getEnvironmentTemplateTierMaps
Retrieves all the environment-template tier maps used by the specified application.
You must specify the projectName
and applicationName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
applicationName |
Name of the application. Argument Type: String |
applicationEntityRevisionId |
(Optional) Revision ID of the versioned object. Argument type: UUID |
orderByEnvironmentTemplateUsage |
(Optional) < Boolean flag— If this is set to Argument Type: Boolean |
ec-perl
syntax: $<object>->getEnvironmentTemplateTierMaps(<projectName>, <applicationName>, {<optionals>});
getEnvironmentTemplateTiers
Retrieves all the environment template tiers in the specified environment template.
You must specify the projectName
and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
includeTemplateDetails |
(Optional) < Boolean flag— If this is set to Argument Type: Boolean |
ec-perl
syntax: $<object>->getEnvironmentTemplateTiers(<projectName>, <environmentTemplateName>, {<optionals>});
getEnvironmentTemplates
Retrieves all the environment templates in the specified project.
You must specify the projectName
argument.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
getHook
Retrieves a hook associated in an entity.
You must specify the hookName
.
Arguments | Descriptions |
---|---|
hookName |
Name of the hook that must be unique among all hooks in the project. Argument Type: String |
projectName |
(Optional) Name of the project to which the procedure belongs. When you use a specific version of a plugin, this is the name of the plugin project. Argument Type: String |
resourceTemplateName |
(Optional) Name of the resource template with the hook. Argument Type: String |
getHooks
Retrieves all the hooks associated with an entity.
Arguments | Descriptions |
---|---|
projectName |
(Optional) Name of the project to which the procedure belongs. When you use a specific version of a plugin, this is the name of the plugin project. Argument Type: String |
resourceTemplateName |
(Optional) Name of the resource template with the hook. Argument Type: String |
getProvisionedEnvironments
Retrieves provisioned environments.
Arguments | Descriptions |
---|---|
flowRuntimeId |
(Optional) The ID of the flow state. Argument Type: UUID |
jobId |
(Optional) include::partial$job-id.adoc[] Argument type: UUID |
stageName |
(Optional) Name of the stage. Argument Type: String |
Response
Returns a provisioned environment element.
===ec-p erl
syntax: $<object>->getEnvironmentTemplate({<optionals>});
getResourcePoolsInEnvironmentTier
Retrieves the list of resource pools in the specified environment tier.
You must specify the projectName
, environmentName
, and environmentTierName
arguments.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentName |
Name of the environment that must be unique among all environments. Argument Type: String |
environmentTierName |
Name of the environment tier that must be unique among all tiers for the environment. Argument Type: String |
ec-perl
syntax: $<object>->getResourcePoolsInEnvironmentTier(<projectName>, <environmentName>, <environmentTierName>);
getResourceTemplate
Retrieves the specified resource template.
You must specify the projectName
and resourceTemplateName
argument.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
resourceTemplateName |
Name for the resource template that must be unique among all resource templates. Argument Type: String |
getResourceTemplates
Retrieves all the resource templates.
You must enter the projectName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
getResourceTemplatesInEnvironmentTemplateTier
Retrieves all the resource templates in the specified environment template tier.
You must specify the projectName
, environmentTemplateName
, and environmentTemplateTierName
arguments.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
ec-perl
syntax: $<object>->getResourceTemplatesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
getResourcesInEnvironmentTemplateTier
Retrieves all the resources in the specified environment template tier.
You must specify the projectName
, environmentTemplateName
,and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name for the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
ec-perl
syntax: $<object>->getResourcesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
modifyEnvironmentTemplate
Modifies an environment template.
You must specify the projectName
and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
newName |
(Optional) New name for the environment template. Argument Type: String |
ec-perl
syntax: $<object>->modifyEnvironmentTemplate(<projectName>, <environmentTemplateName>, {<optionals>});
modifyEnvironmentTemplateTier
Modifies all the environment template tiers in the specified environment template.
You must specify the projectName
, environmentTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name for the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
newName |
(Optional) New name for the environment template tier. Argument Type: String |
resourceCount |
(Optional) Number of resources to be spun from the resource template. Argument Type: Integer |
resourceNames |
(Optional) List of resources to add to the environment tier. Argument type: Collection |
resourceTemplateName |
(Optional) Name for the resource template that must be unique among all resource templates. Argument type: String |
resourceTemplateProjectName |
(Optional) Name of the project to which the resource template belongs. Argument Type: String |
ec-perl
syntax: $<object>->modifyEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>,{<optionals>});
modifyEnvironmentTemplateTierMap
Modifies an existing environment template tier map.
You must specify the projectName
, applicationName
, environmentProjectName
, and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
applicationName |
Name of the application. Argument Type: String |
environmentProjectName |
Name for the project to which the environment belongs. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
applicationEntityRevisionId |
(Optional) Revision ID of the versioned object. Argument Type: UUID |
tierMapName |
(Optional) Name of the tier map associated with the environment template. If you do not specify an tier map, CloudBees CD uses a tier map with a hyphenated-application-and-environment name. Argument type: String |
tierMappings |
(Optional) List of mappings between the application tiers and the environment template tiers. Argument Type: Map |
ec-perl
syntax: $<object>->modifyEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});
modifyEnvTemplTierResourceTemplMapping
Modifies the resource count in an environment template tier.
You must specify the resourceCount
, projectName
, environmentTemplateName
, resourceTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
resourceCount |
Number of resources to provision from the specified resource template. Argument Type: Integer |
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
resourceTemplateName |
Name of the resource template that must be unique among all resource templates. Argument Type: String |
environmentTemplateTierName |
Name for the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
resourceTemplateProjectName |
(Optional) Name for the project to which the resource template belongs. Argument Type: String |
Positional arguments
resourceCount
, projectName
, environmentTemplateName
, resourceTemplateName
, environmentTemplateTierName
ec-perl
syntax: $<object>->modifyEnvTempTierResourceTemplMapping(<resourceCount>, <projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
ectool
syntax: ectool modifyEnvTempTierResourceTemplMapping <resourceCount> <resourceTemplateName> <projectName> <environmentTemplateName> <environmentTemplateTierName>
modifyHook
Modifies an existing hook in a resource template.
You must specify the hookName
.
Arguments | Descriptions |
---|---|
hookName |
Name of the hook that must be unique among all hooks in the project. Argument Type: String |
broadcast |
(Optional) Broadcast flag Use this flag to broadcast the hook name in the project. The Argument type: Boolean |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
hookParameters |
(Optional) Parameters that are passed to the procedure. Argument type: Map |
hookType |
(Optional)Type of the hook:
Argument Type: String |
newName |
New name for the hook. |
procedureName |
Name of the procedure that the hook references. Argument Type: String |
procedurePluginKey |
(Optional) Name of the plugin procedure. Use this argument when the hook references a plugin procedure. The promoted version of the plugin is invoked by default. Argument Type: String |
procedureProjectName |
(Optional) Name of the project to which the procedure belongs. When you use a specific version of a plugin, this is the name of the plugin project. Argument Type: String |
projectName |
(Optional) Project name of the entity that owns the hook. Argument Type: String |
resourceTemplateName |
(Optional) Name of the resource template with the hook. Argument Type: String |
modifyResourceTemplate
Modifies the specified resource template.
You must specify the projectName
and resourceTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
resourceTemplateName |
Name for the resource template that must be unique among all resource templates. Argument Type: String |
cfgMgrParameters |
(Optional) Parameters that are passed from the configuration-manager plugin to CloudBees CD . Argument type: Map |
cfgMgrPluginKey |
(Optional) Name of the configuration-manager plugin. Argument Type: String |
cfgMgrProcedure |
(Optional) Name of the configuration-manager plugin method. Argument Type: String |
cfgMgrProjectName |
(Optional) Name of the project to which the configuration-manager plugin applies. Argument Type: String |
cloudProviderParameters |
(Optional) Parameters that are passed from the cloud- provider plugin to CloudBees CD . Argument Type: Map |
cloudProviderPluginKey |
(Optional) Name of the cloud-provider plugin. Parameters that are passed from the cloud-provider plugin to CloudBees CD . Argument Type: String |
cloudProviderProcedure |
Name of the cloud-provider plugin method. Argument Type: String |
cloudProviderProjectName |
(Optional) Name of the project to which the cloud-provider plugin applies. Argument Type: String |
description |
(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with This text is not interpreted by the automation platform. Argument type: String |
newName |
New name for the resource template. Argument type: String |
ec-perl
syntax: $<object>->modifyResourceTemplate(<projectName>, <resourceTemplateName>, {<optionals>});
provisionEnvironment
Provisions an environment.
You must specify the projectName
, environmentName
, and environmentTemplateName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects Argument Type: String |
environmentName |
Name of the environment. Argument Type: String |
environmentTemplateName |
Name for the environment template that must be unique among all environment templates. Argument Type: String |
environmentTemplateProjectName |
(Optional) Name of the project containing specified environment template. If this argument is not specified, the default is the environment project name. Argument Type: String |
keepOnError |
(Optional) The Set this flag to Argument type: Boolean |
tierResourceCounts |
(Optional) Resource count for each environment template tier. Argument type: Map |
ec-perl
syntax: $<object>->provisionEnvironment(<projectName>, <environmentName>, <environmentTemplateName>, {<optionals>});
provisionResourcePool
Provisions a resource pool.
You must specify the resourceCount
, resourcePoolName
, projectName
, and resourceTemplateName
.
Arguments | Descriptions |
---|---|
resourceCount |
Number of resources to provision. Argument Type: String |
resourcePoolName |
Name of the resource pool. Argument Type: String |
projectName |
Name of the project that must be unique among all projects Argument Type: String |
resourceTemplateName |
Name for the resource template that must be unique among all resource templates. Argument Type: String |
keepOnError |
(Optional) The Set this flag to Argument type: Boolean |
ec-perl
syntax: $<object>->provisionResourcePool(<resourceCount>, <resourcePoolName>, <projectName>, <resourceTemplateName>,{<optionals>});
removeResourceFromEnvironmentTemplateTier
Removes a resource from an environment template tier.
You must specify the resourceName
, projectName
, environmentTemplateName
, and environmentTemplateTierName
Arguments | Descriptions |
---|---|
resourceName |
Name of the resource that must be unique among all resources. Argument Type: String |
projectName |
Name of the project. This name must be unique among all projects. Argument Type: String Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
environmentTemplateTierName |
Name for the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
Positional arguments
resourceName, projectName, environmentTemplateName, environmentTemplateTierName
ec-perl
syntax: $<object>->removeResourceFromEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);
removeResourcePoolFromEnvironmentTier
Removes a resource pool from the specified environment tier.
You must specify the resourcePoolName
, projectName
, environmentName
, and environmentTierName
arguments.
Arguments | Descriptions |
---|---|
resourcePoolName |
Name of the resource pool that must be unique among all resource pools. Argument Type: String |
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentName |
Name of the environment that must be unique among all environments. Argument Type: String |
environmentTierName |
Name of the environment tier that must be unique among all tiers for the environment. Argument Type: String |
ec-perl
syntax: $<object>->removeResourcePoolFromEnvironmentTier (<resourcePoolName>, <projectName>, <environmentName>, <environmentTierName>);
removeResourceTemplateFromEnvironmentTemplateTier
Removes a resource template from the specified environment template tier.
You must specify the resourceTemplateName
, projectName
, environmentTemplateName
, and environmentTemplateTierName
.
Arguments | Descriptions |
---|---|
projectName |
Name of the project that must be unique among all projects. Argument Type: String |
environmentTemplateName |
Name of the environment template. Argument Type: String |
resourceTemplateName |
Name of the resource template that must be unique among all resource templates. Argument Type: String |
environmentTemplateTierName |
Name of the environment template tier that must be unique among all tiers for the environment template. Argument Type: String |
resourceTemplateProjectName |
(Optional) Name for the project to which the resource template belongs. Argument Type: String |
Positional arguments
projectName, environmentTemplateName, resourceTemplateName, environmentTemplateTierName
ec-perl
syntax: $<object>->removeResourceTemplateFromEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});
ectool
syntax: ectool removeResourceTemplateFromEnvironmentTemplateTier <resourceTemplateName> <projectName> <environmentTemplateName> <environmentTemplateTierName> [optionals]
tearDown
Removes (decommissions) dynamic environments that are no longer needed.
Arguments | Descriptions |
---|---|
environmentName |
(Optional) Name of the environment. Argument Type: String |
pollInterval |
(Optional) This argument requires setting a value in seconds to determine how often ectool queries the CloudBees CD server for job status, but this is not an indefinite activity–set the If this option is not specified, If it is specified, Argument type: Integer |
projectName |
(Optional) Name of the project that must be unique among all projects. Argument Type: String |
resourceName |
(Optional) Name of the resource. Argument Type: String |
resourcePoolName |
(Optional) Name of the resource pool. Argument Type: String |
timeout |
(Optional) This argument requires a value set in seconds . If If Argument type: Integer |
Response
Returns a jobId
.
If the --pollInterval
option is provided, CloudBees CD wait until the job completes up to a maximum of --timeout
seconds (if also provided).