modifyProcess

Back to index

Summary

Modifies an existing process.

projectName

Stringrequired

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

processName

Stringrequired

The name of the process.

applicationName

Stringoptional

The name of the application, if the process is owned by an application.

componentApplicationName

Stringoptional

If specified, the component is scoped to this application not the project.

componentName

Stringoptional

The name of the component, if the process is owned by a component.

credentialName

Stringoptional

The name of a credential to attach to this process.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

exclusiveEnvironment

Booleanoptional

True if environment is exclusive to the application or service process.

microserviceApplicationName

Stringoptional

If specified, the microservice is scoped to an application.

microserviceName

Stringoptional

The name of the microservice, if the process is owned by a microservice.

newName

Stringoptional

The new name for an existing object that is being renamed.

processType

Stringoptional

Defines type of action performed by the process.

Possible values: "DEPLOY", "OTHER", "UNDEPLOY"

smartUndeployEnabled

Booleanoptional

True if smart deploy should be enabled for the undeploy component process.

timeLimit

Stringoptional

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

Stringoptional

Units for step time limit: seconds, minutes, or hours.

Possible values: "hours", "minutes", "seconds"

workingDirectory

Stringoptional

Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job's workspace.

workspaceName

Stringoptional

The name of the default workspace for this process.

Usage

Perl

$cmdr->modifyProcess(
  "test-projectName", # projectName
  "test-processName" # processName
  # optionals
);▼

ectool

ectool modifyProcess \
  "test-projectName" `# projectName` \
  "test-processName" `# processName` \
  # optionals▼

Examples

Perl

To modify a component process in a master component:

$cmdr->modifyProcess('Default', 'Deploy',  {componentName => 'WAR file', newName => 'Daily Update'});▼

To modify a component process in a specific application:

$cmdr->modifyProcess('Default', 'Deploy',  {componentName => 'WAR file', componentApplicationName => 'Shopping Cart', newName => 'Daily Update'});▼

To modify an application process:

$cmdr->modifyProcess('Default', 'Deploy',  {applicationName => 'Shopping Cart', newName => 'Daily Update'});▼

ectool

To modify a component process in a master component:

ectool modifyProcess 'Default' 'Deploy'  --componentName 'WAR file' --newName 'Daily Update'▼

To modify a component process in a specific application:

ectool modifyProcess 'Default' 'Deploy' --componentName 'WAR file' --componentApplicationName 'Shopping Cart' --newName 'Daily Update'▼

To modify an application process:

ectool modifyProcess  'Default' 'Deploy'  --applicationName 'Shopping Cart' --newName 'Daily Update'▼