Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Get-SCSMWorkflowStatus

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 the System Center Data Access service runs. The user account that is specified in the Credential parameter must have access rights to the specified computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the credentials that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights to that server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-DisplayName<String[]>

Specifies the display name of the workflow object to retrieve.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

-Id<Guid[]>

Specifies the unique ID 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 retrieve.


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 (http://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.


  • System.Guid

    You can pipe a GUID of a workflow object to the Id parameter.


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: Get the status of all workflows

This command retrieves the status of all workflows.


C:\PS>Get-SCSMWorkflowStatus

Example 2: Get the status of a single workflow

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


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

Example 3: Get the status of underlying activities

The first command retrieves the status of the ServiceManager.ActivityManagement.ActivityStatusChangedRule workflow, and then stores it in the $Status variable.

The second command retrieves the status of the underlying activities of the workflow in $Status.


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

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft