getProcesses

Back to index

Summary

Retrieves all processes in an application or component.
projectName
Stringrequired
The name for the project that must be unique among all projects.
applicationEntityRevisionId
UUIDoptional
The revision ID of the versioned object.
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.
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.

Usage

Perl

$cmdr->getProcesses( "test-projectName" # projectName # optionals );

ectool

ectool getProcesses \ "test-projectName" `# projectName` \ # optionals

Examples

Perl

To retrieve all the component process in a master component:

$cmdr->getProcesses('Default', {componentName => 'WAR file'});

To retrieve all the component processes in a specific application:

$cmdr->getProcesses('Default', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});

To retrieve all the application processes in the specified application:

$cmdr->getProcesses('Default', {applicationName => 'Shopping Cart'});

ectool

To retrieve a component process in a master component:

ectool getProcesses 'Default' --componentName 'WAR file'

To retrieve a component process in a specific application:

ectool getProcesses 'Default' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'

To retrieve an application process in a specific application:

ectool getProcesses 'Default' --applicationName 'Shopping Cart'