Edit

Share via

Remove-CMTSStepPrepareConfigMgrClient

Module:
ConfigurationManager Module

Remove the Prepare ConfigMgr Client for Capture step from a task sequence.

Syntax

ByValue (Default) 

Remove-CMTSStepPrepareConfigMgrClient
    [-InputObject] <IResultObject>
    [-StepName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById 

Remove-CMTSStepPrepareConfigMgrClient
    [-TaskSequenceId] <String>
    [-StepName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

Remove-CMTSStepPrepareConfigMgrClient
    [-TaskSequenceName] <String>
    [-StepName <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to remove an instance of the Prepare ConfigMgr Client for Capture step from a task sequence.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

This example first gets a task sequence object in the $tsOsd variable. It then passes that variable as the input object to remove the Prepare ConfigMgr Client for Capture step.

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsStepNamePrepClient = "Prepare ConfigMgr Client for Capture"
Remove-CMTSStepPrepareConfigMgrClient -InputObject $tsOsd -StepName $tsStepNamePrepClient -Force

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Run the command without asking for confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify a task sequence object from which to remove the Prepare ConfigMgr Client for Capture step. To get this object, use the Get-CMTaskSequence cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TaskSequence

Parameter sets

ByValue
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-StepName

Specify the name of the Prepare ConfigMgr Client for Capture step to remove from the task sequence.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceId

Specify the package ID of the task sequence from which to remove the Prepare ConfigMgr Client for Capture step. This value is a standard package ID, for example XYZ00858.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id, TaskSequencePackageId

Parameter sets

ById
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceName

Specify the name of the task sequence from which to remove the Prepare ConfigMgr Client for Capture step.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object