Update-SCSMDCMWorkflow
Update-SCSMDCMWorkflow
Updates properties of a DCM workflow.
Syntax
Parameter Set: Default
Update-SCSMDCMWorkflow [-Workflow] <DCMWorkflow[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-SCSMDCMWorkflow cmdlet updates properties of a Desired Configuration Management (DCM) workflow.
Parameters
-PassThru
Indicates that this cmdlet returns the workflow that it updates. You can pass this object to other cmdlets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Workflow<DCMWorkflow[]>
Specifies the instance of a DCM workflow to update.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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.
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Workflows.DCMWorkflow
You can pipe a DCM workflow to the Workflow parameter.
Outputs
The output type is the type of the objects that the cmdlet emits.
None.
This cmdlet does not generate any output.
Examples
Example 1: Change the description of a workflow
This example changes the description of a DCM workflow.
The first command gets workflows by using the Get-SCSMDCMWorkflow cmdlet. The command stores the workflow in the $Workflow variable.
PS C:\> $Workflow = Get-SCSMDCMWorkflow -DisplayName "Activity Event Workflow Configuration"
The second command assigns a new value to the Description property of $Workflow.
PS C:\> $Workflow.Description = "This is a new description"
The third command passes the contents of $Workflow to the Format-List cmdlet by using the pipeline operator. The command displays the contents of $Workflow as a list.
PS C:\> $Workflow | Format-List
The final command updates the workflow to match the current value stored in $Workflow.
PS C:\> Update-SCSMDCMWorkflow -Workflow $Workflow