Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyComponent

Back to index

Summary

Modifies an existing component.
projectName
Stringrequired
The name for the project that must be unique among all projects.
componentName
Stringrequired
The name of the component.
actualParameters
Mapoptional
Parameters passed as arguments to the application component.
applicationName
Stringoptional
The name of an application to scope this component to.
clearActualParameters
Booleanoptional
If true, the step should remove all actual parameters.
credentialName
Stringoptional
The name of a credential to attach to this component.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName
Stringoptional
The new name for an existing object that is being renamed.
pluginKey
Stringoptional
The key of the plugin.
pluginName
Stringoptional
The name of the plugin.
pluginParameters
Mapoptional
List of plugin parameters.

Usage

Perl

$cmdr->modifyComponent(
  "test-projectName", # projectName
  "test-componentName" # componentName
  # optionals
);
▼

ectool

ectool modifyComponent \
  "test-projectName" `# projectName` \
  "test-componentName" `# componentName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyComponent("Default", "Web Server", {credentialName => "cred1", newName => "Master Web Server"});
▼

ectool

ectool modifyComponent "Default" "Web Server" --credentialName cred1 --newName "Master Web Server"
▼