Application tier maps

createTierMap

Creates a tier map for an application.

Required arguments

projectName

Name of the project. This name must be unique among all projects.Argument Type: String

String

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects.

String

environmentName

Name of the environment that must be unique among all applications in the project.

String

Optional arguments

applicationEntityRevisionId

Revision ID of the versioned object.

UUID

tierMapName

The name of the tier map. If not specified, the operation will generate a name of the form as follows: <applicationName>-<environmentName>.

String

tierMappings

List of mappings between the application tiers and the environment tiers. The list shows the mappings as <applicationTier>=<environmentTier>.

Map

Response

Returns a tier-map element.

ec-perl

Syntax:

$<object>->createTierMap(<projectName>, <applicationName>,  <environmentProjectName>, <environmentName>, {<optionals>});▼

Example:

$ec->createTierMap("Default", "Deploy", "Default", "Prod",
{tierMapping => [{applicationTier => "Tomcat",
environmentTier => "Server 1"}, {applicationTier => "AWS",
environmentTier => "Server 2"}], tierMapName => "Web Apps"});▼

ectool

Syntax:

ectool createTierMap <projectName> <applicationName>  <environmentProjectName> <environmentName> [optionals]▼

Example:

ectool createTierMap "Default" "Deploy" "Default" "Prod" --tierMapName "Web Apps"
--tierMapping "Tomcat"="Server 1" "AWS"="Server 2"▼

createTierMapping

Creates a tier mapping in the specified tier map for the application.

Required arguments

projectName

Name of the project. This name must be unique among all projects.

String

Required arguments to specify tier map. See Specifying tier mappings for details.

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentName

Name of the environment that must be unique among all applications in the project.

String

tierMapName

The name of the tier map. Alternatively, specify a tier map with applicationName - environmentName.

String

Optional arguments

applicationEntityRevisionId

Revision ID of the versioned object. If not specified, null is stored.

UUID

applicationTierName

Name of the application’s tier name that must be unique among all projects.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects. If not specified, null is stored.

String

environmentTierName

Name of the environment’s tier name that must be unique among all projects.

String

resourceExpression

A resource expression. If not specified, null is stored.

String

tierMappingName

A mapping between the application tier and the environment tier. Alternatively, specify a tier map with applicationTierName - environmentTierName. If not specified one is generated by the system.

Map

Response

Returns a TierMapping element.

=== Specifying tier mappings

Use one of the following combination of arguments to define the tier map name and tier mapping name objects based on what objects your already have. You must specify a tier map and optionally, a tier mapping.

applicationName, tierMapName, tierMappingName
applicationName, applicationTierName, environmentTierName, tierMapName
applicationName, applicationTierName, environmentName, environmentTierName

ec-perl

Syntax:

$<object>->createTierMap(<projectName>, <tier map and tier mapping spec>, {<optionals>});▼

Example:

$ec->createTierMapping("proj1", {applicationTierName => "appTier1", environmentTierName => "envTier2", tierMappingName => "mapping1" tierMapName => "map1"})▼

ectool

Syntax:

ectool createTierMapping <projectName> <tier map and tier mapping spec>, [optionals]▼

Example:

ectool createTierMapping 'proj1' --applicationTierName 'appTier1' --environmentTierName 'envTier2' --tierMapName 'map1' --tierMappingName 'mapping1'▼

deleteTierMap

Deletes a tier map from an application.

Required arguments

projectName

Name of the project. This name must be unique among all projects.Argument Type: String

String

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects.

String

environmentName

Name of the environment that must be unique among all applications in the project.

String

Optional arguments

None

Response

None or a status OK message.

ec-perl

Syntax:

$<object>->deleteTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>);▼

Example:

$ec->deleteTierMap("Default", "Deploy", "Q4 Summary", "App Server" );▼

ectool

Syntax:

ectool deleteTierMap <projectName> <applicationName> <environmentProjectName> <environmentName>▼

Example:

ectool deleteTierMap "Default" "Deploy" "Q4 Summary" "App Server"▼

deleteTierMapping

Deletes a tier mapping from a tier map.

Required arguments

projectName

Name of the project. This name must be unique among all projects.Argument Type: String

String

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects.

String

environmentName

Name of the environment that must be unique among all applications in the project.

String

applicationTierName

Name of the application tier.

String

Optional arguments

applicationEntityRevisionId

Revision ID of the versioned object.

UUID

Response

Deletes the specified tier mapping.

ec-perl

Syntax:

$<object>->deleteTierMapping(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>, <applicationTierName>);▼

Example:

$ec->deleteTierMapping("Default", "Deploy", "Q4 Summary", "PROD", "Config");▼

ectool

Syntax:

ectool deleteTierMapping <projectName> <applicationName> <environmentProjectName> <environmentName> <applicationTierName>▼

Example:

ectool deleteTierMapping "Default" "Deploy" "Q4 Summary" "PROD" "Config"▼

getTierMaps

Retrieves all tier maps that are used by an application.

Required arguments

projectName

Name of the project. This name must be unique among all projects.Argument Type: String

String

applicationName

Name of the application that must be unique among all projects.

String

Optional arguments

applicationEntityRevisionId

The revision ID of the versioned project.

UUID

orderByEnvironmentUsage

< Boolean flag— 0|1|true|false >– If this is set to 1 or true, the response will have the most recently used environment in the tier maps.

Boolean

Response

Returns a list of tier maps.

ec-perl

Syntax:

$<object>->getTierMaps(<projectName>, <applicationName>, {<optionals>});▼

Example:

$ec->getTierMaps("Default", "Take snapshot", {applicationEntityRevisionId => "4fa765dd-73f1-11e3-b67e-b0a420524153"});▼

ectool

Syntax:

ectool getTierMaps <projectName> <applicationName> [optionals]▼

Example:

ectool getTierMaps "Default" "Take snapshot" --applicationEntityRevisionId 4fa765dd-73f1-11e3-b67e-b0a420524153▼

modifyTierMap

Modifies an existing tier map.

Required arguments

projectName

Name of the project. This name must be unique among all projects.Argument Type: String

String

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects.

String

environmentName

Name of the environment.

String

Optional arguments

applicationEntityRevisionId

Revision ID of the versioned object.

UUID

tierMapName

New name of the tier map. If this argument is not specified the tier map is a hyphenated application and environment name.

String

tierMappings

List of mappings between the application tiers and the environment tiers. The list shows the mappings as <applicationTier>=<environmentTier>. If you use this argument, new tier mappings are added or existing mappings are updated for the specified application tiers. This argument does not replace all the mappings and thus does not remove the mappings that were not specified in the API call. To remove mappings, use the deleteTierMapping command.

Map

Response

Returns the updated tier map.

ec-perl

Syntax:

$<object>->modifyTierMap(<projectName>, <applicationName>, <environmentProjectName>, <environmentName>), {<optionals>});▼

Example:

$ec->modifyTierMap("Default", "Deploy", "Utilities", "Web Server",
tierMappings => [{applicationTier => "AppTier1", environmentTier => "EnvTier1"}, {applicationTier => "AppTier2", environmentTier => "EnvTier2"}], tierMapName => "TierMap1"});▼

ectool

Syntax:

ectool modifyTierMap <projectName> <applicationName> <environmentProjectName> <environmentName> [optionals]▼

Example:

ectool modifyTierMap "Default" "Deploy" "Utilities" "Web Server" --tierMapName TierMap1 --tierMapping AppTier1=EnvTier1 AppTier2=EnvTier2▼

modifyTierMapping

Moodifies a tier mapping in the specified tier map for the application.

Required arguments

projectName

Name of the project. This name must be unique among all projects.

String

Required arguments to specify tier map. See Specifying tier mappings for details.

applicationName

Name of the application that must be unique among all applications in the project.

String

environmentName

Name of the environment that must be unique among all applications in the project.

String

tierMapName

The name of the tier map. Alternatively, specify a tier map with applicationName - environmentName.

String

Optional arguments

applicationEntityRevisionI

Revision ID of the versioned object. If not specified, null is stored.

UUID

applicationTierName

Name of the application’s tier name that must be unique among all projects.

String

environmentProjectName

Name of the environment’s project that must be unique among all projects. If not specified, null is stored.

String

environmentTierName

Name of the environment’s tier name that must be unique among all projects.

String

newName

The new name of this object. If not specified, current name is stored.

String

resourceExpression

A resource expression. If not specified, null is stored.

String

tierMappingName

A mapping between the application tier and the environment tier. Alternatively, specify a tier map with applicationTierName - environmentTierName. If not specified one is generated by the system.

Map

Response

Returns a TierMapping element.

=== Specifying tier mappings

Use one of the following combination of arguments to define the tier map name and tier mapping name objects based on what objects your already have. You must specify a tier map and optionally, a tier mapping.

applicationName, tierMapName, tierMappingName
applicationName, applicationTierName, environmentTierName, tierMapName
applicationName, applicationTierName, environmentName, environmentTierName

ec-perl

Syntax:

$<object>->modifyTierMapping(<projectName>, <tier map and tier mapping spec>, {<optionals>});▼

Example:

$ec->modifyTierMapping("proj1", {applicationTierName => "appTier1", environmentTierName => "envTier2", tierMappingName => "mapping1" tierMapName => "map1"})▼

ectool

Syntax:

ectool createTierMapping <projectName> <tier map and tier mapping spec>, [optionals]▼

Example:

ectool createTierMapping 'proj1' --applicationTierName 'appTier1' --environmentTierName 'envTier2' --tierMapName 'map1' --tierMappingName 'mapping1'
        --tierMappingName "Tomcat"="Server 1" "AWS"="Server 2"▼