wfstop
usage: wfstop [ -immediate ] <pattern match expression for workflow names> ...
This command stops one or more workflows.
With this command you compare a single pattern match expression, or several, with the full workflow name, <folder>.<workflowconfigurationname>.<workflowname>
, of all the workflows.
The command accepts wild cards, such as '*' and '?'. For further information see Textual Pattern Matches.
The command does not kill all processes, but rather sends a message to all the agents to stop.
If the workflow cannot be stopped, an error message will be shown stating why it was not stopped.
The command accepts the following option:
Option | Description |
---|---|
[-immediate] | The workflow is stopped without waiting for a batch to finish. |
Return Codes
Listed below are the different return codes for the wfstop
command:
Code | Description |
---|---|
0 | Will be returned if the command was successful or if the argument count is incorrect. |
1 | Will be returned if no user is logged in. |
1-> | The number of non-matching workflow names as parameters, or the number of failed workflow stops. |