Skip to content

Latest commit

 

History

History
189 lines (136 loc) · 4.27 KB

Remove-CMTSStepCaptureSystemImage.md

File metadata and controls

189 lines (136 loc) · 4.27 KB
external help file Module Name ms.date online version schema
AdminUI.PS.psm1-help.xml
ConfigurationManager
08/11/2021
2.0.0

Remove-CMTSStepCaptureSystemImage

SYNOPSIS

Remove the Capture OS Image step from a task sequence.

SYNTAX

ByValue (Default)

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

ById

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

ByName

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

DESCRIPTION

Use this cmdlet to remove an instance of the Capture OS Image 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 Capture OS Image step.

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

$tsStepNameCapOSImg = "Capture OS Image"
Remove-CMTSStepCaptureSystemImage -InputObject $tsOsd -StepName $tsStepNameCapOSImg -Force

PARAMETERS

-Force

Run the command without asking for confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specify a task sequence object from which to remove the Capture OS Image step. To get this object, use the Get-CMTaskSequence cmdlet.

Type: IResultObject
Parameter Sets: ByValue
Aliases: TaskSequence

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-StepName

Specify the name of the Capture OS Image step to remove from the task sequence.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TaskSequenceId

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

Type: String
Parameter Sets: ById
Aliases: Id, TaskSequencePackageId

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TaskSequenceName

Specify the name of the task sequence from which to remove the Capture OS Image step.

Type: String
Parameter Sets: ByName
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-CMTSStepCaptureSystemImage New-CMTSStepCaptureSystemImage Set-CMTSStepCaptureSystemImage

About task sequence steps: Capture OS Image