Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

modifyActualParameter

Back to index

Summary

Modify an existing actual parameter.

An actual parameter is a name/value pair passed to a subprocedure. This command supports renaming the actual parameter and setting its value.

  • You must enter projectName, actualParameterName, workflowDefinitionName, and stateDefinitionName for workflow state parameters.

  • In CloudBees CD/RO 5.0 and later, you must enter projectName, procedureName, stepName, and actualParameterName to modify procedure parameters.

  • In CloudBees CD/RO versions prior to 5.0, you must enter projectName, procedureName, and actualParameterName to modify procedure parameters.
projectName
Stringrequired
The name for the project that must be unique among all projects.
procedureName
Stringrequired
The name of the procedure.
stepName
Stringrequired
The name of the step.
actualParameterName
Stringrequired
The name of the parameter to create/modify/delete.
applicationName
Stringoptional
The name of the application, if the actual parameter is on an application process step.
archiveConnectorName
Stringoptional
The name of the archive connector.
catalogItemName
Stringoptional
The name of the catalog item.
catalogItemRunId
Stringoptional
The ID of the catalog item run, if the actual parameter is on a catalog item run.
catalogName
Stringoptional
The name of the catalog.
componentName
Stringoptional
The name of the component, if the actual parameter is on a component process step.
dashboardName
Stringoptional
The name of the dashboard.
flowName
Stringoptional
The name of the flow to which the flow state belongs to.
flowStateName
Stringoptional
The name of the flow state, if the formal parameter is on a flow state.
newName
Stringoptional
The new name for an existing object that is being renamed.
pipelineName
Stringoptional
The name of the pipeline.
processName
Stringoptional
The name of the process, if the actual parameter is on a process step.
processStepName
Stringoptional
The name of the process step, if the actual parameter is on a process step.
releaseName
Stringoptional
The name of the release, if the actual parameter is on a release.
scheduleName
Stringoptional
The name of the schedule.
stateDefinitionName
Stringoptional
The name of the state definition.
tierMapName
Stringoptional
The name of the tier map.
transitionDefinitionName
Stringoptional
The name of the state definition.
triggerName
Stringoptional
The name of the trigger.
value
Stringoptional
The value of the actual parameter, if creating or modifying.
widgetName
Stringoptional
The name of the widget.
workflowDefinitionName
Stringoptional
The name of the workflow definition.

Usage

Perl

$cmdr->modifyActualParameter(
  "test-projectName", # projectName
  "test-procedureName", # procedureName
  "test-stepName", # stepName
  "test-actualParameterName" # actualParameterName
  # optionals
);
▼

ectool

ectool modifyActualParameter \
  "test-projectName" `# projectName` \
  "test-procedureName" `# procedureName` \
  "test-stepName" `# stepName` \
  "test-actualParameterName" `# actualParameterName` \
  # optionals
▼

Examples

Perl

$cmdr->modifyActualParameter("Default", "Final run", "Take snapshot",
  "Software level", {newName => "Software version"});
▼

ectool

ectool modifyActualParameter "Default" "Final run" "Take snapshot"
  "Software level" --newName "Software version"
▼