Get-SCSMWorkflow

Get-SCSMWorkflow

Retrieves configuration information for Service Manager workflows.

Syntax

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

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

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

Detailed Description

The Get-SCSMWorkflow cmdlet retrieves configuration information for Service Manager workflows.

Parameters

-ComputerName<String[]>

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

Aliases

none

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the credential to use when you are connecting to the Service Manager 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 display name of the workflow configuration to retrieve. This can be a regular expression.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Id<Guid[]>

Specifies the ID of the workflow configuration to retrieve.

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 configuration to retrieve. This can be a regular expression.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies the 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 name to the DisplayName parameter of the Get-SCSMWorkflow cmdlet.

  • System.Guid

    You can pipe a GUID to the Id parameter of the Get-SCSMWorkflow cmdlet.

Outputs

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

  • Microsoft.EnterpriseManagement.ServiceManager.Sdk.Workflows.Workflow

    This cmdlet retrieves information about workflows.

Examples

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

This command retrieves workflow configuration.

PS C:\>Get-SCSMWorkflow

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

This example retrieves the configuration of the ”Activity Event Workflow Configuration” workflow.

PS C:\>$wf = Get-SCSMWorkflowConfiguration "Activity Event Workflow Configuration"
PS C:\>$wf | format-list
PS C:\> $wf.ManualActivity

Get-SCSMWorkflowStatus

New-SCSMDCMWorkflow

Remove-SCSMWorkflow

Update-SCSMWorkflow