Get-CVWorkflow

The Get-CVWorkflow cmdlet retrieves a workflow from 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

Get-CVWorkflow [<CommonParameters>]

Get-CVWorkflow [-Name <String>] [<CommonParameters>]

Get-CVWorkflow [-Id <Int32>] [<CommonParameters>]

Optional Parameters

Commvault Parameters

Parameter	Description	Data type	Values	Accepts pipeline input?	Accepts wildcard characters?	Type of parameter
-Name	The name of the workflow.	String		Yes, by: Value Property name	No	Named
-Id	The ID of the workflow.	Int32	The default value is 0.	Yes, by: Value Property name	No	Named

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

-Name

The name of the workflow.

String

Yes, by:

Value
Property name

Named

-Id

The ID of the workflow.

Int32

The default value is 0.

Yes, by:

Value
Property name

Named

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 workflows.

Example

Get Workflow By Name

This example retrieves the DBMaintenance workflow.

Get-CVWorkflow -Name DBMaintenance

Get Workflow By ID

This example retrieves the workflow with ID 7.

Get-CVWorkflow -Id 7