Get-SCSMWorkflowStatus

Article
07/28/2015

Get-SCSMWorkflowStatus

Retrieves the status of workflows in Service Manager.

Syntax

Parameter Set: FromDisplayName
Get-SCSMWorkflowStatus [[-DisplayName] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromId
Get-SCSMWorkflowStatus [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromName
Get-SCSMWorkflowStatus [-Name] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Get-SCSMWorkflowStatus cmdlet retrieves the status of workflows in Service Manager.

Parameters

-ComputerName<String[]>

Specifies the name of the computer on which System Center Data Access service runs.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies the credential to use when connecting to the System Center Data Access service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-DisplayName<String[]>

Specifies the DisplayName of the workflow object to be retrieved.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-Id<Guid[]>

Specifies the ID (GUID) of the workflow object to be retrieved.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Name<String[]>

Specifies the name of the workflow object to be retrieved.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-SCSession<Connection[]>

Specifies an object that represents the session to a Service Manager management server.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

System.String

You can pipe a workflow name to the DisplayName parameter of the Get-SCSMWorkflowStatus cmdlet.
System.Guid

You can pipe a GUID of a workflow object to the Id parameter of the Get-SCSMWorkflowStatus cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Microsoft.EnterpriseManagement.Configuration.ManagementPackRule

This cmdlet retrieves information about workflows.

Examples

-------------------------- EXAMPLE 1 --------------------------

This command retrieves the status of all workflows.

C:\PS>Get-SCSMWorkflowStatus

-------------------------- EXAMPLE 2 --------------------------

This command retrieves the status of the ServiceManager.ActivityManagement.ActivityStatusChangedRule workflow.

PS C:\>Get-SCSMWorkflowStatus -Name ServiceManager.ActivityManagement.ActivityStatusChangedRule

-------------------------- EXAMPLE 3 --------------------------

This command retrieves the status of each of the underlying activities of a workflow.

PS C:\>$Status = Get-SCSMWorkflowStatus -Name ServiceManager.ActivityManagement.ActivityStatusChangedRule

PS C:\>$Status.GetStatus()

Get-SCSMWorkflowStatus