Clear-CMPxeDeployment

Clears the status of the most recent PXE deployment in Configuration Manager.

Syntax

Clear-CMPxeDeployment
     [-Confirm]
     -Device <IResultObject>
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [<CommonParameters>]
Clear-CMPxeDeployment [-Confirm] -DeviceCollection  [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] []
Clear-CMPxeDeployment [-Confirm] -DeviceCollectionId  [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] []
Clear-CMPxeDeployment [-Confirm] -DeviceCollectionName  [-DisableWildcardHandling]
 [-ForceWildcardHandling] [-WhatIf] []
Clear-CMPxeDeployment [-Confirm] -DeviceName  [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] []
Clear-CMPxeDeployment [-Confirm] [-DisableWildcardHandling] [-ForceWildcardHandling] -ResourceId 
 [-WhatIf] []

Description

The Clear-CMPxeDeployment cmdlet clears the status of the most recent Pre-Boot EXecution Environment (PXE) deployment in Microsoft System Center Configuration Manager.

You can redeploy a required PXE deployment for a collection of devices. Clear the status of the last PXE deployment assigned to that System Center Configuration Manager collection. System Center Configuration Manager redeploys the most recent required deployments.

Examples

Example 1: Clear a PXE deployment for a device collection

PS C:\>Clear-CMPxeDeployment -DeviceCollectionId "SMS00072"

This command clears a PXE deployment identified with a device collection ID.

Required Parameters

-Device

Specifies a device object. To obtain a device object, use the Get-CMDevice cmdlet.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-DeviceCollection

Specifies a device collection object. To obtain a device collection object, use the Get-CMDeviceCollection cmdlet.

Type:IResultObject
Aliases:Collection
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-DeviceCollectionId

Specifies an array of IDs of device collections.

Type:String[]
Aliases:CollectionId, DeviceCollectionIds, CollectionIds
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeviceCollectionName

Specifies an array of names of device collections.

Type:String[]
Aliases:CollectionName, DeviceCollectionNames, CollectionNames
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeviceName

Specifies an array of names of devices.

Type:String[]
Aliases:DeviceNames
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies an array of IDs for resources. The cmdlet clears the status of the PXE deployment for these resources.

Type:Int32[]
Aliases:ResourceIds
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

Indicates that wildcard handling is enabled.

Type:SwitchParameter
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 is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False