Dynamic Environments

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

Positional arguments

resourcePoolName, projectName, environmentName, environmentTierName

Response

Returns the resource pool and environment tier elements.

ec-perl

syntax: $<object>->addResourcePoolToEnvironmentTier(<resourcePoolName>, <projectName>, <environmentName>, <environmentTierName>, {<optionals>});

Example

$cmdr->addResourcePoolToEnvironmentTier("pool1", "Default", "Production", "Web Server", {rollingDeployPhaseName => "Blue PROD"});

ectool

syntax: ectool addResourcePoolToEnvironmentTier <resourcePoolName> <projectName> <environmentName> <environmentTierName> [optionals]

Example

ectool addResourcePoolToEnvironmentTier "pool1" "Default" "Production" "Web Server" --rollingDeployPhaseName "Blue PROD"

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

Response

Returns the resource template and environment template tier elements.

ec-perl

syntax: $<object>->addResourceTemplateToEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});

Example

$ec->addResourceTemplateToEnvironmentTemplateTier("Default", "Production", "Test station", "WebServer", {resourceCount => 4});

ectool

syntax: ectool addResourceTemplateToEnvironmentTemplateTier <resourceTemplateName> <projectName> <environmentTemplateName> <environmentTemplateTierName> [optionals]

Example

ectool addResourceTemplateToEnvironmentTemplateTier  "default" "Production" "Test station" "WebServer" --resourceCount 4

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

Response

Returns the resource and environment template tier elements.

ec-perl

syntax: $<object>->addResourceToEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->addResourceToEnvironmentTemplateTier("Test station", "Default", "QA", "Tomcat");

ectool

syntax: ectool addResourceToEnvironmentTemplateTier <resourceName> <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool addResourceToEnvironmentTemplateTier "Test station" "Default" "QA" "Tomcat"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

This text is not interpreted by CloudBees CD .

Argument type: String

Positional arguments

projectName, environmentTemplateName

Response

Returns an environment template object.

ec-perl

syntax: $<object>->createEnvironmentTemplate(<projectName>, <environmentTemplateName>, {<optionals>});

Example

$ec->createEnvironmentTemplate("Default", "PROD Server");

ectool

syntax: ectool createEnvironmentTemplate <projectName> <environmentTemplateName> [optionals]

Example

ectool createEnvironmentTemplate "Default" "PROD Server"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

Returns an environment tier in an environment template.

ec-perl

syntax: $<object>->createEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>, {<optionals>});

Example

$ec->createEnvironmentTemplateTier("Default", "PROD Server", "Web Services");

ectool

syntax: ectool createEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName> [optionals]

Example

ectool createEnvironmentTemplateTier "Default" "PROD Server" "Web Services"

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

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Response

Returns a tier map for the environment template.

ec-perl

syntax: $<object>->createEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});

Example

$ec->createEnvironmentTemplateTierMap("Default", "Undeploy", "PROD", "Web Services");

ectool

syntax: ectool createEnvironmentTemplateTierMap <projectName> <applicationName> <environmentProjectName> <environmentTemplateName> [optionals]

Example

ectool createEnvironmentTemplateTierMap "Default" "Undeploy" "PROD" "Web Services

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 broadcast value = < Boolean flag - 0|1|true|false >. Defaults to true or 1.

Argument type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

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:

  • PRE_PROVISIONING

  • POST_PROVISIONING

  • PRE_CONFIGUARTION

  • POST_CONFIGUARTION

  • PRE_TEARDOWN

  • POST_TEARDOWN

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

Positional arguments

hookName

Response

Returns a hook for a resource template.

ec-perl

syntax: $<object>->createHook(<hookName>, {<optionals>});

Example

$ec->createHook("Config Web Server", {hooktype => PRE_CONFIGURATION, procedureName => "Server Start", procedureProjectName => "Servers");

ectool

syntax: ectool createHook <hookName> [optionals]

Example

ectool createHook "Config Web Server" --hookType PRE_CONFIGURATION --procedureName "Server Start" --procedureProjectName "Servers"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

This text is not interpreted by the automation platform.

Argument type: String

Positional arguments

projectName, resourceTemplateName

Response

Returns a resource template.

ec-perl

syntax: $<object>->createResourceTemplate(<projectName>, <resourceTemplateName>, {<optionals>});

Example

$ec->createResourceTemplate("Default", "QE testing", {cloudProviderProjectName => "Deploy all"});

ectool

syntax: ectool createResourceTemplate <project Name> <resourceTemplateName> [optionals]

Example

ectool createResourceTemplate "Default" "QE testing" --cloudProviderProjectName "Deploy all"

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

Positional arguments

projectName, environmentTemplateName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteEnvironmentTemplate(<projectName>, <environmentTemplateName>);

Example

$ec->deleteEnvironmentTemplate("Default", "Production");

ectool

syntax: `ectool deleteEnvironmentTemplate <projectName> <environmentTemplateName> `

Example

ectool deleteEnvironmentTemplate "Default" "Production"

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->deleteEnvironmentTemplateTier("Default", "Production", "Repository");

ectool

syntax: ectool deleteEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool deleteEnvironmentTemplateTier "Default" "Production" "Repository"

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

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName> <environmentTemplateName>);

Example

$ec->deleteEnvironmentTemplateTierMap("Default", "Undeploy", "Software tools", "Repository");

ectool

syntax: ectool deleteEnvironmentTemplateTierMap <projectName> <applicationName> <environmentProjectName> <environmentTemplateName>

Example

ectool deleteEnvironmentTemplateTierMap "Default" "Undeploy" "Software tools" "Repository"

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

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteEnvironmentTemplateTierMapping(<projectName>, <applicationName>, <environmentProjectName> <environmentTemplateName> <applicationTierName>);

Example:

$ec->deleteEnvironmentTemplateTierMapping("Default", "Undeploy", "Production", "Repository", "Database");

ectool

syntax: ectool deleteEnvironmentTemplateTierMapping <projectName> <applicationName> <environmentProjectName> <environmentTemplateName> <applicationTierName>

Example:

ectool deleteEnvironmentTemplateTierMapping "Default" "Undeploy" "Production" "Repository" "Database"

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

Positional arguments

hookName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteHook(<hookName>, {<optionals>});

Example

$ec->deleteHook("AWS config", {resourceTemplateName => "AWS backup server"});

ectool

syntax: ectool deleteHook <hookName> [optionals]

Example

ectool deleteHook "AWS config" --resourceTemplateName "AWS backup server"

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

Positional arguments

projectName, resourceTemplateName

Response

None or a status OK message.

ec-perl

syntax: $<object>->deleteResourceTemplate(<projectName>, <resourceTemplateName>);

Example

$ec->deleteResourceTemplate("Default", "QA Test");

ectool

syntax: ectool deleteResourceTemplate <projectName> <resourceTemplateName>

Example

ectool deleteResourceTemplate "Default" "QA Test"

getAvailableResourcesForEnvironment

Retrieves all non-dynamic resources or resource pools.

Arguments Descriptions

includePoolUsage

(Optional) < Boolean flag— 0|1|true|false >

If this is set to true or 1, the pool usage is also retrieved.

Argument Type: Boolean

objectTypeToReturn

(Optional) Flag to return resources or resource pools. Valid values are resources or resourcePools.

If this is set to true or 1, resources or resource pools are also retrieved.

Argument Type: String

Response

Returns resource or resource pool objects.

ec-perl

syntax: $<object>->getAvailableResourcesForEnvironment({<optionals>});

Example

$ec->getAvailableResourcesForEnvironment({objectTypeToReturn => "resources"});

ectool

syntax: ectool getAvailableResourcesForEnvironment [optionals]

Example

ectool getAvailableResourcesForEnvironment --objectTypeToReturn "resources"

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

Positional arguments

projectName, environmentTemplateName

Response

An environmentTemplate element.

===ec-p erl

syntax: $<object>->getEnvironmentTemplate(<projectName>, <environmentTemplateName>);

Example

$ec->getEnvironmentTemplate("Default", "QA testing");

ectool

syntax: ectool getEnvironmentTemplate <projectName> <environmentTemplateName>

Example

ectool getEnvironmentTemplate "Default" "QA testing"

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

An environmentTemplateTier element.

ec-perl

syntax: $<object>-getEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->getEnvironmentTemplateTier("Default", "QA testing", "Repository");

ectool

syntax: ectool createEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool createEnvironmentTemplateTier "Default" "QA testing" "Repository"

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— 0|1|true|false >

If this is set to 1 or true, the most recently used environment templates is used.

Argument Type: Boolean

Positional arguments

projectName, applicationName

Response

One or more environmentTemplateTierMap elements.

ec-perl

syntax: $<object>->getEnvironmentTemplateTierMaps(<projectName>, <applicationName>, {<optionals>});

Example

$ec->getEnvironmentTemplateTierMaps("Default", "Undeploy");

ectool

syntax: ectool getEnvironmentTemplateTierMaps <projectName> <applicationName> [optionals]

Example

ectool getEnvironmentTemplateTierMaps "Default" "Undeploy"

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— 0|1|true|false >

If this is set to 1 or true, the response includes the template details.

Argument Type: Boolean

Positional arguments

projectName, environmentTemplateName

Response

One or more environmentTemplateTier elements.

ec-perl

syntax: $<object>->getEnvironmentTemplateTiers(<projectName>, <environmentTemplateName>, {<optionals>});

Example

$ec->getEnvironmentTemplateTiers("Default", "QA testing");

ectool

syntax: ectool getEnvironmentTemplateTiers <projectName> <environmentTemplateName> [optionals]

Example

ectool getEnvironmentTemplateTiers "Default" "QA testing"

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

Positional arguments

projectName

Response

One or more environmentTemplate elements.

ec-perl

syntax: $<object>->getEnvironmentTemplates(<projectName>);

Example

$ec->getEnvironmentTemplates("Default");

ectool

syntax: ectool getEnvironmentTemplates <projectName>

Example

ectool getEnvironmentTemplates "Default"

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

Positional arguments

hookName

Response

Returns a hook for a resource template.

ec-perl

syntax: $<object>->getHook(<hookName>, {<optionals>});

Example

$ec->getHook("Config Web Server", {resourceTemplateName => "Servers"});

ectool

syntax: ectool getHook <hookName> [optionals]

Example

ectool getHook "Config Web Server" --resourceTemplateName "Servers"

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

Positional arguments

None

Response

Returns all the hooks for a resource template.

ec-perl

syntax: $<object>->getHooks({<optionals>});

Example

$ec->getHooks({projectName => "Default", resourceTemplateName => "AWS servers"});

ectool

syntax: ectool getHooks [optionals]

Example

ectool getHooks --projectName "Default" --resourceTemplateName "AWS servers"

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

Positional arguments

None

Response

Returns a provisioned environment element.

===ec-p erl

syntax: $<object>->getEnvironmentTemplate({<optionals>});

Example

$ec->getEnvironmentTemplate({jobId => "5da765dd-73f1-11e3-b67e-b0a420524153", stageName => "PROD"});

ectool

syntax: ectool getEnvironmentTemplate [optionals]

Example

ectool getEnvironmentTemplate --jobId "5da765dd-73f1-11e3-b67e-b0a420524153" --stageName "PROD"

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

Positional arguments

projectName, environmentName, environmentTierName

Response

One or more resourcePool elements.

ec-perl

syntax: $<object>->getResourcePoolsInEnvironmentTier(<projectName>, <environmentName>, <environmentTierName>);

Example

$cmdr->getResourcePoolsInEnvironmentTier("Default", "Production", "Web Server");

ectool

syntax: ectool getResourcePoolsInEnvironmentTier <projectName> <environmentName> <environmentTierName>

Example

ectool getResourcePoolsInEnvironmentTier "Default" "Production" "Web Server"

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

Positional arguments

projectName, resourceTemplateName

Response

A resourceTemplate element.

ec-perl

syntax: $<object>->getResourceTemplate(<projectName>, <resourceTemplateName>);

Example

$ec->getResourceTemplate("Default", "System Test");

ectool

syntax: ectool getResourceTemplate <projectName> <resourceTemplateName>

Example

ectool getResourceTemplate "Default" "System Test"

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

Positional arguments

projectName

Response

One or more resourceTemplate elements.

ec-perl

syntax: $<object>->getResourceTemplates(<projectName>);

Example

$ec->getResourceTemplates("Default");

ectool

syntax: ectool getResourceTemplates <projectName>

Example

ectool getResourceTemplates "Default"

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

One or more resourceTemplate elements.

ec-perl

syntax: $<object>->getResourceTemplatesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->getResourceTemplatesInEnvironmentTemplateTier("Default", "Production", "Web Server");

ectool

syntax: ectool getResourceTemplatesInEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool getResourceTemplatesInEnvironmentTemplateTier "Default" "Production" "Web Server"

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

One or more resource elements.

ec-perl

syntax: $<object>->getResourcesInEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->getResourcesInEnvironmentTemplateTier("Default", "QA testing", "Tomcat");

ectool

syntax: ectool getResourcesInEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool getResourcesInEnvironmentTemplateTier "Default" "QA testing" "Tomcat"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

This text is not interpreted by the automation platform.

Argument type: String

newName

(Optional) New name for the environment template.

Argument Type: String

Positional arguments

projectName, environmentTemplateName

Response

Returns a modified resourceTemplate element.

ec-perl

syntax: $<object>->modifyEnvironmentTemplate(<projectName>, <environmentTemplateName>, {<optionals>});

Example

$ec->modifyEnvironmentTemplate("Default", "Dev Test 1");

ectool

syntax: ectool modifyEnvironmentTemplate <projectName> <environmentTemplateName> [optionals]

Example

ectool modifyEnvironmentTemplate "Default" "Dev Test 1"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

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

Positional arguments

projectName, environmentTemplateName, environmentTemplateTierName

Response

Returns a modified environmentTemplateTier element.

ec-perl

syntax: $<object>->modifyEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <environmentTemplateTierName>,{<optionals>});

Example

$ec->modifyEnvironmentTemplateTier("Default", "QA test", "Database");

ectool

syntax: ectool modifyEnvironmentTemplateTier <projectName> <environmentTemplateName> <environmentTemplateTierName> [optionals]

Example

ectool modifyEnvironmentTemplateTier "Default" "QA test" "Database"

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

Positional arguments

projectName, applicationName, environmentProjectName, environmentTemplateName

Response

Returns a modified environmentTemplateTier element.

ec-perl

syntax: $<object>->modifyEnvironmentTemplateTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentTemplateName>, {<optionals>});

Example

$ec->modifyEnvironmentTemplateTierMap("Default", "Undeploy", "Utilities", "Servers");

ectool

syntax: ectool modifyEnvironmentTemplateTierMap <projectName> <applicationName> <environmentProjectName> <environmentTemplateName> [optionals]

Example

ectool modifyEnvironmentTemplateTierMap "Default" "Undeploy" "Utilities" "Servers"

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

Response

None or a status OK message.

ec-perl

syntax: $<object>->modifyEnvTempTierResourceTemplMapping(<resourceCount>, <projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});

Example

$ec->modifyEnvTempTierResourceTemplMapping(5, "Servers", "Default", Dev1", "Database", {resourceTemplateProjectName =>"Utilities" });

ectool

syntax: ectool modifyEnvTempTierResourceTemplMapping <resourceCount> <resourceTemplateName> <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool modifyEnvTempTierResourceTemplMapping 5 "Servers" "default" Dev1" "Database" --resourceTemplateProjectName "Utilities"

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 broadcast value = < Boolean flag - 0|1|true|false >. Defaults to true or 1.

Argument type: Boolean

description

(Optional) A plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

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:

  • PRE_PROVISIONING

  • POST_PROVISIONING

  • PRE_CONFIGUARTION

  • POST_CONFIGUARTION

  • PRE_TEARDOWN

  • POST_TEARDOWN

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

Positional arguments

hookName

Response

None or a status OK message.

ec-perl

syntax: $<object>->modifyHook(<hookName>, {<optionals>});

Example

$ec->modifyHook("config", {newName => "prod_config"});

ectool

syntax: ectool modifyHook <hookName> [optionals]

Example

ectool modifyHook "config" --newName  "prod_config"

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 <html> …​ </html> tags. The only HTML tags allowed in the text are: <a> <b> <br> <div> <dl> <font> <i> <li> <ol> <p> <pre> <span> <style> <table> <tc> <td> <th> <tr> <ul>.

This text is not interpreted by the automation platform.

Argument type: String

newName

New name for the resource template.

Argument type: String

Positional arguments

projectName, resourceTemplateName

Response

None or a status OK message.

ec-perl

syntax: $<object>->modifyResourceTemplate(<projectName>, <resourceTemplateName>, {<optionals>});

Example

$ec->modifyResourceTemplate("Default", "System Test", {newName => "System Test 1"});

ectool

syntax: ectool modifyResourceTemplate <projectName> <resourceTemplateName> [optionals]

Example

ectool modifyResourceTemplate "Default" "System Test" --newName "System Test 1"

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 keepOnError error flag value is < Boolean flag - 0|1|true|false >.

Set this flag to 1 or true to keep the environment when an error occurs .The default is 0 or false.

Argument type: Boolean

tierResourceCounts

(Optional) Resource count for each environment template tier.

Argument type: Map

Positional arguments

projectName, environmentName, environmentTemplateName

Response

Returns a jobId. You need to wait for the job to be completed before using the resources.

ec-perl

syntax: $<object>->provisionEnvironment(<projectName>, <environmentName>, <environmentTemplateName>, {<optionals>});

Example

$ec->provisionEnvironment("Default", "Main servers", "Build Server", {keepOnError => 1});

ectool

syntax: ectool provisionEnvironment <projectName> <environmentName> <environmentTemplateName> [optionals]

Example

ectool provisionEnvironment "Default" "Main servers" "Build Server" --keepOnError 1

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 keepOnError error flag value is < Boolean flag - 0|1|true|false >.

Set this flag to 1 or true to keep the environment when an error occurs .The default is 0 or false.

Argument type: Boolean

Positional arguments

resourceCount, resourcePoolName, projectName, resourceTemplateName

Response

Returns a jobId. You need to wait for the job to be completed before using the resources.

ec-perl

syntax: $<object>->provisionResourcePool(<resourceCount>, <resourcePoolName>, <projectName>, <resourceTemplateName>,{<optionals>});

Example

$ec->provisionResourcePool("12", "QE build", "Default",  "Servers", {keepOnError => 1});

ectool

syntax: ectool provisionResourcePool <resourceCount> <resourcePoolName> <projectName> <resourceTemplateName> [optionals]

Example

ectool provisionResourcePool "12" "QE build" "Default" "Servers" --keepOnError 1

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

Response

Removes the specified resource from the environment template tier.

ec-perl

syntax: $<object>->removeResourceFromEnvironmentTemplateTier(<resourceName>, <projectName>, <environmentTemplateName>, <environmentTemplateTierName>);

Example

$ec->removeResourceFromEnvironmentTemplateTier("Web Server", "Default", "QA lab", "Tomcat");

ectool

syntax: ectool removeResourceFromEnvironmentTemplateTier <resourceName> <projectName> <environmentTemplateName> <environmentTemplateTierName>

Example

ectool removeResourceFromEnvironmentTemplateTier "Web Server" "Default" "QA lab" "Tomcat"

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

Positional arguments

resourcePoolName, projectName, environmentName, environmentTierName

Response

None or a status OK message.

ec-perl

syntax: $<object>->removeResourcePoolFromEnvironmentTier (<resourcePoolName>, <projectName>, <environmentName>, <environmentTierName>);

Example

$ec->removeResourcePoolFromEnvironmentTier("pool1", "Default", "Production", "Web Server");

ectool

syntax: ectool removeResourcePoolFromEnvironmentTier <resourcePoolName> <projectName> <environmentName> <environmentTierName>

Example

ectool removeResourcePoolFromEnvironmentTier "pool1" "Default" "Production" "Web Server"

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

Response

None or a status OK message.

ec-perl

syntax: $<object>->removeResourceTemplateFromEnvironmentTemplateTier(<projectName>, <environmentTemplateName>, <resourceTemplateName>, <environmentTemplateTierName>, {<optionals>});

Example

$ec->removeResourceTemplateFromEnvironmentTemplateTier("Default", "QA lab", "Tester 1", "App Server", {resourceTemplateProjectName => "QA test"});

ectool

syntax: ectool removeResourceTemplateFromEnvironmentTemplateTier <resourceTemplateName> <projectName> <environmentTemplateName> <environmentTemplateTierName> [optionals]

Example

ectool removeResourceTemplateFromEnvironmentTemplateTier "Default", "QA lab", "Tester 1", "App Server" --resourceTemplateProjectName "QA test"

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 timeout value to extend the pollInterval for longer than 60 seconds if needed.

If this option is not specified, runProcedure returns immediately.

If it is specified, runProcedure waits until the job completes.

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 pollInterva l is specified, this timeout causes runProcedure to stop waiting for the job to complete. It does not stop the job itself.

If pollInterval is used and timeout is not used, pollInterval will timeout in 60 seconds.

Argument type: Integer

Positional arguments

None

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

ec-perl

To tear down (decommission) an environment:

syntax: $<object>->tearDown ({<optionals>});

Example

$ec->tearDown ({environmentName => "Server backup", projectName => "Default"});

ectool

To tear down (decommission) an environment:

syntax: ectool tearDown [optionals]

Example

ectool tearDown --environmentName "Server backup" --projectName "Default"