The Start-CVWorkflow cmdlet executes a workflow in the CommCell environment.
Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.
Syntax
Start-CVWorkflow -WorkflowObject <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Start-CVWorkflow -Name <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Start-CVWorkflow -Id <Int32> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the workflow. | String | Yes, by:
| No | Named | |
| The ID of the workflow. | Int32 | The default value is 0. | Yes, by:
| No | Named |
| An object of the workflow. | Object | Yes, by:
| No | Named |
Optional Parameters
Microsoft PowerShell Parameters
You can use the following Microsoft PowerShell parameters:
Debug
ErrorAction
ErrorVariable
OutBuffer
OutVariable
PipelineVariable
Verbose
WarningAction
WarningVariable
Force
Confirm
WhatIf
Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.
For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.
Input
This cmdlet does not support input.
Output
A PSCustomObject that contains the workflow results.
Examples
Start Workflow By Name
This example starts the DBMaintenance workflow.
Start-CVWorkflow -Name DBMaintenanceStart Workflow By ID
This example starts the workflow with ID 7.
Start-CVWorkflow -Id 7