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. 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 |
localhost |
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 configuration to retrieve. You can specify 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. You can specify 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.
System.Guid
You can pipe a GUID to the Id parameter.
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: Get workflow configuration
This command retrieves the workflow configuration.
PS C:\>Get-SCSMWorkflow
Example 2: Get the Activity Event Workflow Configuration
This example retrieves the configuration of the Activity Event Workflow Configuration workflow.
This command gets information for the specified workflow, and then stores it in the $Workflow variable.
PS C:\> $WorkFlow = Get-SCSMWorkflow -DisplayName "Activity Event Workflow Configuration"
This command passes the contents of $Workflow to the Format-List cmdlet. That cmdlet displays the results as a list.
PS C:\> $WorkFlow | Format-List
This command uses standard dot syntax to display the ManualActivity property of $Workflow.
PS C:\> $WorkFlow.ManualActivity