Controller 24.3

# StartService

The `StartService` action starts the service that you specify using the `Port` parameter.

## Example

    a=StartService&Port=9000

    a=StartService&Port=9000&ControlMethod=SCM

    a=StartService&Port=9000&ControlMethod=Script

NOTE: You must have Windows administrator privileges to use this action.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Port | The port that the service that you want to start is running on.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
ControlMethod | The control method to use to start the service.

## Comments

You can also submit this action from Coordinator by specifying the `ControllerUUID` parameter. By default, the action is asynchronous, but you can run it synchronously by setting the `Synchronous` parameter to `True`.

If the response is successful, the response contains the following information:

- A token for the Controller server(`<ControllerToken>`).
- The request port number (`<Port>`).
- The UUID of the Controller server in question (as specified by the `ControllerUUID` parameter).

You can use the token with the `QueueInfo` action to find the status of the action. For example:

    action=SendAction&ControllerUUID=<UUID>&Command=QueueInfo&QueueAction=GetStatus&QueueName=<Action>&Token=<ControllerToken>

If the response fails, it contains an error. Usually this is as a result of an issue with underlying Controller server, or as a result of an issue with Coordinator itself if the Controller server is down.

For more information, refer to the Coordinator Reference.

## See Also

- AddService
- EditServiceInfo
- FindServices
- GetServices
- RemoveService
- RestartService
- StopService

Copyright 2015-2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Controller 24.3

Topic Title: StartService