Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyReservation

Back to index

Summary

Modifies an environment reservation.
projectName
Stringrequired
The name for the project that must be unique among all projects.
reservationName
Stringrequired
The name of the environment reservation.
applicationName
Stringoptional
The name of the application.
beginDate
Stringoptional
Date of beginning reservation.
blackout
Booleanoptional
Do not allow executions against an environment at specified period.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
endDate
Stringoptional
The date when reservation event ends.
environmentName
Stringoptional
The name of the environment.
environmentProjectName
Stringoptional
The name of the environment project name.
environmentTierName
Stringoptional
The name of the environment tier.
monthDays
Stringoptional
A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.
newName
Stringoptional
The new name for an existing object that is being renamed.
overlap
Booleanoptional
Allow to overlap the reservation.
pipelineName
Stringoptional
The name of the pipeline.
recurrence
Booleanoptional
Recurrence reservation.
recurrenceEndDate
Stringoptional
Date of beginning reservation.
releaseName
Stringoptional
The name of the release.
timeZone
Stringoptional
The time zone to use when interpreting times.
weekDays
Stringoptional
Days of the week: any number of names such as Monday or Tuesday, separated by spaces.

Usage

Perl

$cmdr->modifyReservation(
  "test-projectName", # projectName
  "test-reservationName" # reservationName
  # optionals
);
▼

ectool

ectool modifyReservation \
  "test-projectName" `# projectName` \
  "test-reservationName" `# reservationName` \
  # optionals
▼

Examples

Perl

$cmdr->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

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'
▼