vtctl Workflow Command Reference
The following vtctl commands are available for administering workflows.
Commands #
WorkflowCreate #
Creates the workflow with the provided parameters. The workflow is also started, unless -skip_start is specified.
Example #
WorkflowCreate [-skip_start] <factoryName> [parameters...]
Flags #
| Name | Type | Definition |
|---|---|---|
| skip_start | Boolean | If set, the workflow will not be started. |
Arguments #
<factoryName>– Required.
Errors #
- the
<factoryName>argument is required for the<WorkflowCreate>command This error occurs if the command is not called with at least one argument. - no workflow.Manager registered
WorkflowStart #
Starts the workflow.
Example #
WorkflowStart <uuid>
Errors #
- the
<uuid>argument is required for the<WorkflowStart>command This error occurs if the command is not called with exactly one argument. - no workflow.Manager registered
WorkflowStop #
Stops the workflow.
Example #
WorkflowStop <uuid>
Errors #
- the
<uuid>argument is required for the<WorkflowStop>command This error occurs if the command is not called with exactly one argument. - no workflow.Manager registered
WorkflowDelete #
Deletes the finished or not started workflow.
Example #
WorkflowDelete <uuid>
Errors #
- the
<uuid>argument is required for the<WorkflowDelete>command This error occurs if the command is not called with exactly one argument. - no workflow.Manager registered
WorkflowWait #
WorkflowWait <uuid>
WorkflowTree #
Displays a JSON representation of the workflow tree.
Example #
WorkflowTree
Errors #
- the
<WorkflowTree>command takes no parameter This error occurs if the command is not called with exactly 0 arguments. - no workflow.Manager registered
WorkflowAction #
WorkflowAction <path> <name>