Clear-CMPxeDeployment
Clears the status of the most recent PXE deployment in Configuration Manager.
Syntax
Clear-CMPxeDeployment
-DeviceCollection <IResultObject>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-CMPxeDeployment
-Device <IResultObject>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-CMPxeDeployment
-DeviceCollectionId <String[]>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-CMPxeDeployment
-DeviceCollectionName <String[]>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-CMPxeDeployment
-DeviceName <String[]>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-CMPxeDeployment
-ResourceId <Int32[]>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Clear-CMPxeDeployment cmdlet clears the status of the most recent Pre-Boot EXecution Environment (PXE) deployment in 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 Configuration Manager collection. Configuration Manager redeploys the most recent required deployments.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Clear a PXE deployment for a device collection
PS XYZ:\>Clear-CMPxeDeployment -DeviceCollectionId "SMS00072"This command clears a PXE deployment identified with a device collection ID.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Device
Specifies a device object. To obtain a device object, use the Get-CMDevice cmdlet.
| Type: | IResultObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DeviceCollectionId
Specifies an array of IDs of device collections.
| Type: | String[] |
| Aliases: | CollectionId, DeviceCollectionIds, CollectionIds |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeviceCollectionName
Specifies an array of names of device collections.
| Type: | String[] |
| Aliases: | CollectionName, DeviceCollectionNames, CollectionNames |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeviceName
Specifies an array of names of devices.
| Type: | String[] |
| Aliases: | DeviceNames |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object