Environment

createEnvironment

Creates a new environment.

Argument Description

projectName

The project name.

Argument Type: String

environmentName

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

Argument Type: String

applicationName

(Optional) Name of the application . Supply one of applicationName or serviceName. Argument Type: String

applicationProjectName

(Optional) Name of the project to which applicationName belongs. Used with applicationName.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentEnabled

(Optional) True to enable rolling deploy on this environment.

Argument Type: Boolean

reservationRequired

(Optional) < Boolean flag - 0|1|true|false > Set this flag to "true" to allow deployments to run using only using environment reservations.

Argument Type: Boolean

rollingDeployEnabled

(Optional) < Boolean flag - 0|1|true|false > Set this flag to "true" or "1" to enable the environment.

Argument Type: Boolean

rollingDeployType

(Optional) The type of rolling deploy supported by the environment.

Argument Type: RollingDeployType

serviceName

(Optional) Name of the service. Supply one of applicationName or serviceName. Argument Type: String

serviceProjectName

(Optional) Name of the project to which serviceName belongs. Used with serviceName.

Argument Type: String

Positional arguments

projectName, environmentName

Response

Returns an environment object.

ec-perl

Syntax:

$->createEnvironment(, , {});


Example:

$ec->createEnvironment("Default", "Web Server", {environmentEnabled => true, description => "Web Services", rollingDeployEnabled => true});

ectool

Syntax:

ectool createEnvironment   [optionals]

Example:

ectool createEnvironment "Default" "Web Server" --environmentEnabled true --description "Web Server" --rollingDeployEnabled true

createEnvironmentInventoryItem

Creates a new environment inventory item.

Argument Description

projectName

Name of the project.

Argument Type: String

environmentName

Name of the environment.

Argument Type: String

Required for application-scoped component objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

componentName

Name of the component that owns the inventory item. Argument Type: String

resourceName

Name of the resource where the item is installed. Argument Type: String

Required for application-scoped service objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Required for project-scoped service objects:

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Optional arguments:

applicationTierName

(Optional) Name of the application tier.

Argument Type: String

artifactName

(Optional) Artifact name for the inventory item.

Argument Type: String

artifactSource

(Optional) Source of the artifact.

Argument Type: String

artifactUrl

(Optional) URL of the artifact.

Argument Type: String

artifactVersion

(Optional) Artifact version for the inventory item.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentProjectName

(Optional) Name of the project to which the environment or environment template belongs.

Argument Type: String

status

(Optional) Deployment status of the inventory item. Possible values include: success, warning, error, skipped

Argument Type: String

Positional arguments

projectName, environmentName

Response

Retrieves an environmentInventoryItem object.

ec-perl

Syntax:

$->createEnvironmentInventoryItem(, , , ,  , {});


Example:

$ec->createEnvironmentInventoryItem("Default", "Web Server", "Deploy", "WAR file", "local", {artifactName =>"com.ec:myApp", artifactVersion=>"3.1", description => "Required"});

ectool

Syntax:

ectool createEnvironmentInventoryItem      [optionals]

Example:

ectool createEnvironmentInventoryItem "Default" "Web Server" "Deploy" "WAR file" "local" -- artifactName "com.ec:myApp" --artifactVersion "3.1" --description "Required"

createEnvironmentMap

Creates a new service environment map for a service.

Argument Description

projectName

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

Argument Type: String

environmentName

Name of the environment.

Argument Type: String

serviceName

(Optional) The name of the service.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentMapName

(Optional) The name of the tier map. If not specified the operation will assume a hyphenated service and environment name.

Argument Type: String

environmentProjectName

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

Argument Type: String

serviceEntityRevisionId

(Optional) Revision ID of the versioned object.

Argument Type: String

Positional arguments

projectName, environmentName

Response

Retrieves an environmentMap object.

ec-perl

Syntax:

$->createEnvironmentMap(, , {});


Example:

$ec->createEnvironmentMap("Default", "Web Server Env", {description => "Required"});

ectool

Syntax:

ectool createEnvironmentMap   [optionals]

Example:

ectool createEnvironmentMap "Default" "Web Server Env" --description "Required"

createReservation

Creates a new reservation.

Argument Description

projectName

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

Argument Type: String

reservationName

The name of the environment reservation.

Argument Type: String

environmentName

The name of the environment.

Argument Type: String

beginDate

The date when the reservation begins, formatted as yyyy-mm-ddThh:mm .

endDate

The date when reservation ends, formatted as yyyy-mm-ddThh:mm .

Argument Type: String

timeZone

The time zone to use when interpreting times.

Argument Type: String

applicationName

(Optional) The name of the application.

Argument Type: String

blackout

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, no deployments are allowed to run during the specified time period.

Argument Type: Boolean

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD .

Argument Type: String

environmentProjectName

(Optional) The name of the environment project.

Argument Type: String

environmentTierName

(Optional) The name of the environment tier.

Argument Type: String

monthDays

(Optional) A list of numbers from 1 to 31 separated by spaces, indicating zero or more days of the month.

Argument Type: String

overlap

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, this reservation can overlap with another reservation. By default, reservations are not overlapped.

Argument Type: Boolean

pipelineName

(Optional) The name of the pipeline.

recurrence

(Optional) < Boolean flag0|1|true|false > Recurrence reservation When this argument is set to true or 1, the reservation is a recurring reservation.

Argument Type: Boolean

recurrenceEndDate

(Optional) The date when the recurring reservation ends.

Argument Type: String

releaseName

(Optional) The name of the release.

Argument Type: String

serviceName

(Optional) The name of the service.

Argument Type: String

weekDays

(Optional) Restricts the schedule to specified days of the week. Specify days of the week separated by spaces. Use English names Monday, Tuesday, etc.

Argument Type: String

Positional arguments

projectName, reservationName

Response

Retrieves an reservation object.

ec-perl

Syntax:

$->createReservation(, , {});


Example:

$ec->createReservation('Default', 'Main branch', {environmentName => "Web Server", applicationName => "Heat Clinic", beginDate => "2019-04-30T00:00", endDate => "2019-05-15T00:00", timeZone => GMT});

ectool

Syntax:

ectool createReservation   [optionals]

Example:

ectool createReservation 'Default' 'Main branch' --environmentName "Web Server" --applicationName "Heat Clinic" --beginDate "2019-04-30T00:00" --endDate "2019-05-15T00:00" --timeZone GMT

deleteEnvironment

Deletes an environment.

Argument Description

projectName

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

environmentName

Name of the environment that must be unique among all projects. Argument Type: String

Positional arguments

projectName, environmentName

Response

None or a status OK message.

ec-perl

Syntax:

$->deleteEnvironment(, );


Example:

$cmdr->deleteEnvironment("Default", "PROD");

ectool

Syntax:

ectool deleteEnvironment  

Example:

ectool deleteEnvironment "Default" "PROD"

deleteEnvironmentInventoryItem

Deletes an inventory item.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

Required for application-scoped component objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

componentName

Name of the component that owns the inventory item. Argument Type: String

resourceName

Name of the resource where the item is installed. Argument Type: String

Required for application-scoped service objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Required for project-scoped service objects:

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Optional arguments:

environmentProjectName

(Optional) Name for the project to which the environment or environment template belongs. Argument Type: String

Positional arguments

projectName, environmentName

Response

None or a status OK message.

ec-perl

Syntax:

$->deleteEnvironmentInventoryItem(, , , , , {optionals});


Example:

$cmdr->deleteEnvironmentInventoryItem("Utilities", "PROD", "Deploy", "WAR file", "Server 1", {environmentProjectName => "Default");

ectool

Syntax:

ectool deleteEnvironmentInventoryItem      [optionals]

Example:

ectool deleteEnvironmentInventoryItem "Utilities" "PROD" "Deploy" "WAR file" "Server 1" --environmentProjectName "Default"

deleteEnvironmentMap

Deletes a microservice environment map from a microservice.

Argument Description

projectName

Argument Type: String include::partial$name-for-the-project.adoc[]

environmentName

Name of the environment that must be unique among all projects. Argument Type: String

environmentProjectName

(Optional) The name of the environment’s project. Argument Type: String

serviceEntityRevisionId

(Optional) Revision ID of the versioned object. Argument Type: UUID

serviceName

(Optional) The name of the service. Argument Type: String

Positional arguments

projectName, environmentName

Response

None or a status OK message.

ec-perl

Syntax:

$->deleteEnvironmentMap(, ), {});


Example:

$cmdr->deleteEnvironmentMap("Default", "PROD", {serviceName => "service1"});

ectool

Syntax:

ectool deleteEnvironmentMap   [optionals]

Example:

ectool deleteEnvironmentMap "Default" "PROD" --serviceName "service1"

deleteReservation

Deletes the specified reservation.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

reservationName

The name of the environment reservation. Argument Type: String

Positional arguments

projectName, reservationName

Response

None or a status OK message.

ec-perl

Syntax:

$->deleteReservation(, );


Example:

$cmdr->deleteReservation("Default", "Main branch");

ectool

Syntax:

ectool deleteReservation  

Example:

ectool deleteReservation "Default" "Main branch"

getEnvironment

Retrieves an environment by name.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment that must be unique among all projects. Argument Type: String

Positional arguments

projectName, environmentName

Response

Returns an environment object.

ec-perl

Syntax:

$->getEnvironment(, );


Example:

$ec->getEnvironment("Default", "Test Server");

ectool

Syntax:

ectool getEnvironment  

Example:

ectool getEnvironment "Default" "Test Server"

getEnvironmentApplications

Retrieves a list of applications installed on the given environment.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

Positional arguments

projectName, environmentName

Response

Returns a list of environmentApplication objects.

ec-perl

Syntax:

$->getEnvironmentApplications(, );


Example:

$ec->getEnvironmentApplications("Default", "Test Server");

ectool

Syntax:

ectool getEnvironmentApplications  

Example:

ectool getEnvironmentApplications "Default" "Test Server"

getEnvironmentDeployments

Gets environment deployments for the specified environment.

Argument Description

projectName

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

environmentName

Name of the environment that must be unique among all projects. Argument Type: String

Positional arguments

projectName, environmentName

Response

One or more environmentDeployment objects.

ec-perl

Syntax:

$->getEnvironmentDeployments(, );


Example:

$cmdr->getEnvironmentDeployments("Default", "PROD");

ectool

Syntax:

ectool getEnvironmentDeployments  

Example:

ectool getEnvironmentDeployments "Default" "PROD"

getEnvironmentInventory

Retrieves a per-component grouped list of inventory items.

Argument Description

Required for application objects without a snapshot:

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

Required for application objects with a snapshot:

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

applicationEntityRevisionId

Revision ID of the versioned object. Argument Type: UUID

Required for project-scoped service objects without a snapshot:

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

Required for project-scoped service objects with a snapshot:

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

serviceEntityRevisionId

Revision Id of the service entity. Argument Type: UUID

Optional:

environmentProjectName

(Optional) Name for the project to which the environment or environment template belongs. Argument Type: String

Positional arguments

projectName, environmentName

Response

Returns zero or more environmentInventory objects.

ec-perl

Syntax:

$->getEnvironmentInventory(, , );


Example:

$ec->getEnvironmentInventory("Default", "Test Server", "Save snapshot");

ectool

Syntax:

ectool getEnvironmentInventory   

Example:

ectool getEnvironmentInventory "Default" "Test Server" "Save snapshot"

getEnvironmentInventoryItem

Retrieves an inventory item.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

Required for application-scoped component objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

componentName

Name of the component that owns the inventory item. Argument Type: String

resourceName

Name of the resource where the item is installed. Argument Type: String

Required for application-scoped service objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Required for project-scoped service objects:

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Optional arguments:

environmentProjectName

(Optional) Name for the project to which the environment or environment template belongs. Argument Type: String

includeResourceDetails

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, the response includes the resource details. The default is false or 0. Argument Type: Boolean

Positional arguments

projectName, environmentName

Response

Retrieves an environmentInventoryItem object.

ec-perl

Syntax:

$->getEnvironmentInventoryItem(, , , , , {});


Example:

$ec->getEnvironmentInventoryItem("Default", "Test Lab", "Save snapshot", "WAR file", "QA server", {environmentProjectName => "QA only"});

ectool

Syntax:

ectool getEnvironmentInventoryItem      [optionals]

Example:

ectool getEnvironmentInventoryItem "Default" "Test Lab" "Save snapshot" "WAR file" "QA server" --environmentProjectName "QA only"

getEnvironmentInventoryItems

Retrieves all the inventory items for a given environment.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

includeResourceDetails

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, the response includes the resource details. The default is false or 0. Argument Type: Boolean

Positional arguments

projectName, environmentName

Response

Retrieves zero or more environmentInventory objects.

ec-perl

Syntax:

$->getEnvironmentInventoryItems(, );


Example:

$ec->getEnvironmentInventoryItems("Default", "Test Lab");

ectool

Syntax:

ectool getEnvironmentInventoryItems  

Example:

ectool getEnvironmentInventoryItems "Default" "Test Lab"

getEnvironmentMaps

Get microservice environment maps.

Argument Description

projectName

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

Argument Type: String

serviceEntityRevisionId

(Optional) Revision ID of the versioned object. Argument Type: UUID

serviceName

(Optional) The name of the service. Argument Type: String

Positional arguments

projectName

Response

Retrieves zero or more environmentMap objects .

ec-perl

Syntax:

$->getEnvironmentMaps(), {});


Example:

$cmdr->getEnvironmentMaps("Default", "PROD", {serviceName => "service1"});

ectool

Syntax:

ectool getEnvironmentMaps   [optionals]

Example:

ectool getEnvironmentMaps "Default" "PROD" --serviceName "service1"

getEnvironments

Retrieves all environments in a project.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

Positional arguments

projectName

Response

Returns zero or more environment objects.

ec-perl

Syntax:

$->getEnvironments();


Example:

$ec->getEnvironments("Default");

ectool

Syntax:

ectool getEnvironments 

Example:

ectool getEnvironments "Default"

getReservation

Retrieves an environment reservation by its name.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

reservationName

The name of the environment reservation. Argument Type: String

beginDate

(Optional) The date when the reservation begins. Argument Type: String

endDate

(Optional) The date when the reservation ends. Argument Type: String

includeTimeslots

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, time slots are included in the reservation response. Argument Type: Boolean

timeZone

(Optional) The time zone to use when interpreting times. Argument Type: String

Positional arguments

projectName,reservationName

Response

Retrieve a reservation object.

ec-perl

Syntax:

$->getReservation(, , {});


Example:

$ec->getReservation("Default", "Main branch", {includeTimeslots => true, timeZone => "local"} );

ectool

Syntax:

ectool getReservation   [optionals]

Example:

ectool getReservation "Default" "Main branch" --includeTimeslots true --timeZone "local"

getReservations

Retrieves all the environment reservations.

Argument Description

applicationName

(Optional) The name of the application. Argument Type: String

beginDate

(Optional) The date when the reservation begins. Argument Type: String

blackout

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, no deployments are allowed to run during the specified time period Argument Type: Boolean

endDate

(Optional) The date when the reservation ends. Argument Type: String

environmentName

(Optional) The name of the environment. Argument Type: String

environmentProjectName

(Optional) The name of the environment project. Argument Type: String

environmentTierName

(Optional) The name of the environment tier. Argument Type: String

includeTimeslots

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, time slots are included in the response. Argument Type: Boolean

pipelineName

(Optional) The name of the pipeline. Argument Type: String

projectName

(Optional) The name for the project that must be unique among all projects. Argument Type: String

releaseName

(Optional) The name of the release. Argument Type: String

reserverTypes

(Optional) The types of the objects reserving the environments (the Reserver). Argument Type: Collection

timeZone

(Optional) The time zone to use when interpreting times. Argument Type: String

Positional arguments

projectName,reservationName

Response

Retrieves zero or more reservation objects.

ec-perl

Syntax:

$->getReservations({});


Example:

$ec->getReservations({environmentName => "PROD", pipelineName => "RC build", includeTimeslots => true, timeZone => "local"});

ectool

Syntax:

ectool getReservations [optionals]

Example:

ectool getReservations --environmentName "PROD" --pipelineName => "RC build" --includeTimeslots true --timeZone "local"

getRunSchedules

Retrieves the run schedules with environment reservations.

Argument Description

beginDate

endDate

(Optional) The beginning and ending dateof the reservation. The format is yyyy-mm-dd . Must be specified if includeTimeslots is false. Argument Type: String

includeTimeslots

(Optional) < Boolean flag— 0|1|true|false > If this is set to true or 1, the response includes the resource count. Argument Type: Boolean

filters

(Optional) Filters to use during the search operation. Argument Type: Collection

timeZone

(Optional) The time zone to use when interpreting times. Argument Type: String

Response

Retrieves zero or more schedule objects.

ec-perl

Syntax:

$->getRunSchedules({});


Example:

$ec->getRunSchedules({beginDate => "2016-07-01", endDate => "2016-09-01", includeTimeslots => true, timeZone => "local"});

ectool

Syntax:

ectool getRunSchedules [optionals]

Example:

ectool getRunSchedules --beginDate "2016-07-01" --endDate => "2016-09-01" --includeTimeslots true --timeZone "local"

modifyEnvironment

Modifies an environment.

Argument Description

projectName

The project name.

Argument Type: String

environmentName

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

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentEnabled

(Optional) True to enable rolling deploy on this environment.

Argument Type: Boolean

newName

(Optional) New name for the environment. Argument Type: String

reservationRequired

(Optional) < Boolean flag - 0|1|true|false > Set this flag to "true" to allow deployments to run using only using environment reservations.

Argument Type: Boolean

rollingDeployEnabled

(Optional) < Boolean flag - 0|1|true|false > Set this flag to "true" or "1" to enable the environment.

Argument Type: Boolean

rollingDeployType

(Optional) The type of rolling deploy supported by the environment.

Argument Type: RollingDeployType

Positional arguments

projectName, environmentName

Response

Returns the modified environment object.

ec-perl

Syntax:

$->modifyEnvironment(, , {});


Example:

$ec->modifyEnvironment("Default", "Pet Store", {newName => "New Pet Store", description => "Pet store website", rollingDeployEnabled => true});

ectool

Syntax:

ectool modifyEnvironment   [optionals]

Example:

ectool modifyEnvironment "Default" "Pet Store" --newName "New Pet Store" --description "Pet store website" --rollingDeployEnabled true

modifyEnvironmentInventoryItem

Modifies an existing environment inventory item.

Argument Description

projectName

Name of the project.

Argument Type: String

environmentName

Name of the environment.

Argument Type: String

Required for application-scoped component objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

componentName

Name of the component that owns the inventory item. Argument Type: String

resourceName

Name of the resource where the item is installed. Argument Type: String

Required for application-scoped service objects:

applicationName

Name of the application. Supply one of applicationName or serviceName. Argument Type: String

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Required for project-scoped service objects:

serviceName

Name of the service. Supply one of applicationName or serviceName. Argument Type: String

containerName

Name of the container. Argument Type: String

Optional arguments:

applicationTierName

(Optional) Name of the application tier.

Argument Type: String

artifactName

(Optional) Artifact name for the inventory item.

Argument Type: String

artifactSource

(Optional) Source of the artifact.

Argument Type: String

artifactUrl

(Optional) URL of the artifact.

Argument Type: String

artifactVersion

(Optional) Artifact version for the inventory item.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentProjectName

(Optional) Name of the project to which the environment or environment template belongs.

Argument Type: String

newName

(Optional) The new name for the object.

Argument Type: String

status

(Optional) Deployment status of the inventory item. Possible values include: success, warning, error, skipped

Argument Type: String

Positional arguments

projectName, environmentName

Response

Retrieves the modified environmentInventoryItem object.

ec-perl

Syntax:

$->modifyEnvironmentInventoryItem(, , , , , {});


Example:

$ec->modifyEnvironmentInventoryItem("Default", "PROD", "Deploy", "WAR file", "Server 1", {artifactVersion => "V3"});

ectool

Syntax:

ectool modifyEnvironmentInventoryItem      [optionals]

Example:

ectool modifyEnvironmentInventoryItem "Default" "PROD" "Deploy" "WAR file" "Server 1" --artifactVersion "V3"

modifyEnvironmentMap

Modifies an existing service environment map.

Argument Description

projectName

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

Argument Type: String

environmentName

Name of the environment.

Argument Type: String

serviceName

(Optional) The name of the service.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted by CloudBees CD .

Argument Type: String

environmentMapName

(Optional) The name of the tier map. If not specified the operation will assume a hyphenated service and environment name.

Argument Type: String

environmentProjectName

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

Argument Type: String

newName

(Optional) New name for an existing object. Argument Type: String

serviceEntityRevisionId

(Optional) Revision ID of the versioned object.

Argument Type: String

Positional arguments

projectName, environmentName

Response

Retrieves an environmentMap object.

ec-perl

Syntax:

$->modifyEnvironmentMap(, , {});


Example:

$ec->modifyEnvironmentMap("Default", "Web Server Env", {description => "Required"});

ectool

Syntax:

ectool modifyEnvironmentMap   [optionals]

Example:

ectool modifyEnvironmentMap "Default" "Web Server Env" --description "Required"

modifyReservation

Modifies an environment reservation.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

reservationName

The name of the environment reservation. Argument Type: String

applicationName

(Optional) The name of the application Argument Type: String

beginDate

(Optional) The date when the reservation begins. Argument Type: String

blackout

(Optional) < Boolean flag0|1|true|false > When this argument is set to true or 1, no deployments are allowed to run during the specified time period. Argument Type: Boolean

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees CD . Argument Type: String

endDate

(Optional) The date when the reservation ends. Argument Type: String

environmentName

(Optional) The name of the environment. Argument Type: String

environmentProjectName

(Optional) The name of the environment project. Argument Type: String

environmentTierName

(Optional) The name of the environment tier. Argument Type: String

monthDays

(Optional) A list of numbers from 1 to 31 separated by spaces, indicating zero or more days of the month. Argument Type: String

newName

(Optional) New name for an existing object. Argument Type: String

overlap

< Boolean flag0|1|true|false > When this argument is set to true or 1, this reservation can overlap with another reservation. By default, reservations are not overlapped. Argument Type: Boolean

pipelineName

(Optional) The name of the pipeline. Argument Type: String

recurrence

(Optional) < Boolean flag0|1|true|false > Recurrence reservation When this argument is set to true or 1, the reservation is a recurring reservation. Argument Type: Boolean

(Optional) recurrenceEndDate

The date when the recurring reservation ends. Argument Type: String

releaseName

(Optional) The name of the release. Argument Type: String

timeZone

(Optional) The time zone to use when interpreting times. Argument Type: String

weekDays

(Optional) Restricts the schedule to specified days of the week. Specify days of the week separated by spaces. Use English names "Monday", "Tuesday". Argument Type: String

Response

Retrieves the modified reservation object.

ec-perl

Syntax:

$->modifyReservation(, , {});


Example:

$ec->modifyReservation('Default', 'Main branch', {environmentName => "Web Server", applicationName => "Heat Clinic", beginDate => '22:00', endDate => '23:30', timeZone => 'local', overlap => false, weekDays => 'Monday' 'Wednesday' 'Friday' 'Sunday'});

ectool

Syntax:

ectool modifyReservation   [optionals]

Example:

ectool modifyReservation 'Default' 'Main branch' --environmentName "Web Server" --applicationName "Heat Clinic" --beginDate '22:00' --endDate '23:30' --timeZone 'local' --overlap true --weekDays 'Monday' 'Wednesday' 'Friday' 'Sunday'

seedEnvironmentInventory

Seeds the environment with a new inventory to mimic an actual application- or release-scoped deployment.

Argument Description

projectName

include::partial$name-for-the-project.adoc[] Argument Type: String

environmentName

Name of the environment. Argument Type: String

applicationName

Application that owns the inventory item. Use for existing applications. Argument Type: String

applicationProcessName

Application process that will be deployed to the environment. Argument Type: String

status

Deployment status of the environment inventory. Argument Type: JobOutcome

Seeding an inventory for a non-existing application (release and not-release scoped):

applicationTierName

Application tier that owns the inventory item. Use for non-existing applications. Argument Type: String

Seeding an inventory for an application object without a snapshot:

resourceNames

Resources assigned to the environment. Argument Type: Collection

componentName

Component that owns the inventory item Argument Type: String

artifactName

Artifact name for the inventory item. Argument Type: String

artifactVersion

Artifact version for the inventory item. Argument Type: String

Seeding an inventory for an application object with a snapshot:

resourceNames

Resources assigned to the environment. Argument Type: Collection

snapshotName

Name of the snapshot. Argument Type: String

Seeding an inventory for a release-scoped application object:

artifactName

Artifact name for the inventory item. Argument Type: String

artifactVersion

Artifact version for the inventory item. Argument Type: String

componentName

Component that owns the inventory item Argument Type: String

releaseName

Name of the release. Argument Type: String

releaseProjectName

Name of the project to which releaseName belongs. Argument Type: String

resourceNames

Resources assigned to the environment. Argument Type: Collection

stageName

Name of the stage. Argument Type: String

Optional arguments:

artifactSource

(Optional) Source of the artifact. Argument Type: String

artifactUrl

(Optional) URL of the artifact. Argument Type: String

environmentProjectName

(Optional) Name for the project to which the environment or environment template belongs. Argument Type: String

Positional arguments

projectName, environmentName, applicationName, applicationProcessName, status

Response

Returns the new environmentInventory object.

ec-perl

Syntax:

$->seedEnvironmentInventory(, , , , , {});


Example:

$ec->seedEnvironmentInventory("Default", "PROD", "Deploy", "Clean up DB", "success", {artifactVersion => "3.0"});

ectool

Syntax:

ectool seedEnvironmentInventory      [optionals]

Example:

ectool seedEnvironmentInventory "Default" "PROD" "Deploy" "Clean up DB" "success" --artifactVersion "3.0"