The cancelWorkflow operation cancels a workflow.

The behavior of the cancelWorkflow operation depends on the workflow that it cancels. A canceled workflow stops running in the Orchestrator server and enters the canceled state, but the actions that it has already run or started running do not stop or reverse themselves. For example, if a workflow is performing a Power On Virtual Machine operation when you cancel it, the virtual machine does not stop powering on, nor does it power itself off if it has already started.

The cancelWorkflow operation is declared as follows.

public void cancelWorkflow(String workflowTokenId, String username, String password);

Type

Value

Description

String

workflowTokenId

The identifier of the running workflow to cancel

String

username

Orchestrator user name

String

password

Orchestrator password

Return Value

No return value. The cancelWorkflow operation returns an exception if you pass it an invalid parameter.